Ping Identity PingAuthorize Server Command-Line Tool Reference

PingAuthorize Server Documentation Index
Command-Line Tool Reference Home

dsconfig

↓Description
↓Examples
↓Subcommands
↓Arguments

Description

View and edit the PingAuthorize 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 PingAuthorize 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 PingAuthorize Server and use them in the batch file.

Examples

Start dsconfig in interactive mode:

dsconfig

Use non-interactive mode to change the amount memory used for caching database contents and to specify common parent DNs that should be compacted in the underlying database:

dsconfig --no-prompt --bindDN uid=admin,dc=example,dc=com \
     --bindPassword password set-backend-prop --backend-name userRoot \
     --set db-cache-percent:40 \
     --add compact-common-parent-dn:ou=accts,dc=example,dc=com \
     --add compact-common-parent-dn:ou=subs,dc=example,dc=com

Use batch mode to read and execute a series of commands in a batch file:

dsconfig --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --no-prompt --batch-file /path/to/config-batch.txt

List information about all available configuration properties for all objects, including inherited properties:

dsconfig list-properties --offline --inherited

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

Subcommands

↓create-access-token-validator
↓create-advice
↓create-alert-handler
↓create-authorization-policy-decision-shared-secret
↓create-azure-authentication-method
↓create-backend
↓create-certificate-mapper
↓create-cipher-stream-provider
↓create-conjur-authentication-method
↓create-connection-handler
↓create-correlation-attribute-pair
↓create-custom-logged-stats
↓create-debug-target
↓create-deployment-package-store
↓create-dn-map
↓create-error-template
↓create-external-server
↓create-failure-lockout-action
↓create-gateway-api-endpoint
↓create-gauge
↓create-gauge-data-source
↓create-http-servlet-cross-origin-policy
↓create-http-servlet-extension
↓create-id-token-validator
↓create-identity-mapper
↓create-impacted-attributes-provider
↓create-key-manager-provider
↓create-key-pair
↓create-ldap-external-server-template
↓create-ldap-health-check
↓create-load-balancing-algorithm
↓create-location
↓create-log-file-rotation-listener
↓create-log-publisher
↓create-log-retention-policy
↓create-log-rotation-policy
↓create-monitor-provider
↓create-monitoring-endpoint
↓create-obscured-value
↓create-passphrase-provider
↓create-password-policy
↓create-password-storage-scheme
↓create-plugin
↓create-policy-configuration-key
↓create-recurring-task
↓create-recurring-task-chain
↓create-root-dn-user
↓create-sasl-mechanism-handler
↓create-scim-attribute
↓create-scim-resource-type
↓create-scim-schema
↓create-scim-sub-resource-type-handler
↓create-scim-subattribute
↓create-secondary-store-adapter
↓create-server-group
↓create-sideband-api-endpoint
↓create-sideband-api-shared-secret
↓create-store-adapter
↓create-store-adapter-mapping
↓create-store-adapter-plugin
↓create-token-claim-validation
↓create-token-resource-lookup-method
↓create-topology-admin-user
↓create-trust-manager-provider
↓create-trusted-certificate
↓create-vault-authentication-method
↓create-velocity-context-provider
↓create-velocity-template-loader
↓create-web-application-extension
↓delete-access-token-validator
↓delete-advice
↓delete-alert-handler
↓delete-authorization-policy-decision-shared-secret
↓delete-azure-authentication-method
↓delete-backend
↓delete-certificate-mapper
↓delete-cipher-stream-provider
↓delete-conjur-authentication-method
↓delete-connection-handler
↓delete-correlation-attribute-pair
↓delete-custom-logged-stats
↓delete-debug-target
↓delete-deployment-package-store
↓delete-dn-map
↓delete-error-template
↓delete-external-server
↓delete-failure-lockout-action
↓delete-gateway-api-endpoint
↓delete-gauge
↓delete-gauge-data-source
↓delete-http-servlet-cross-origin-policy
↓delete-http-servlet-extension
↓delete-id-token-validator
↓delete-identity-mapper
↓delete-impacted-attributes-provider
↓delete-key-manager-provider
↓delete-key-pair
↓delete-ldap-external-server-template
↓delete-ldap-health-check
↓delete-load-balancing-algorithm
↓delete-location
↓delete-log-file-rotation-listener
↓delete-log-publisher
↓delete-log-retention-policy
↓delete-log-rotation-policy
↓delete-monitor-provider
↓delete-monitoring-endpoint
↓delete-obscured-value
↓delete-passphrase-provider
↓delete-password-policy
↓delete-password-storage-scheme
↓delete-plugin
↓delete-policy-configuration-key
↓delete-recurring-task
↓delete-recurring-task-chain
↓delete-root-dn-user
↓delete-sasl-mechanism-handler
↓delete-scim-attribute
↓delete-scim-resource-type
↓delete-scim-schema
↓delete-scim-sub-resource-type-handler
↓delete-scim-subattribute
↓delete-secondary-store-adapter
↓delete-server-group
↓delete-sideband-api-endpoint
↓delete-sideband-api-shared-secret
↓delete-store-adapter
↓delete-store-adapter-mapping
↓delete-store-adapter-plugin
↓delete-token-claim-validation
↓delete-token-resource-lookup-method
↓delete-topology-admin-user
↓delete-trust-manager-provider
↓delete-trusted-certificate
↓delete-vault-authentication-method
↓delete-velocity-context-provider
↓delete-velocity-template-loader
↓delete-web-application-extension
↓get-access-control-handler-prop
↓get-access-token-validator-prop
↓get-advice-prop
↓get-alarm-manager-prop
↓get-alert-handler-prop
↓get-authorization-policy-decision-shared-secret-prop
↓get-azure-authentication-method-prop
↓get-backend-prop
↓get-certificate-mapper-prop
↓get-cipher-secret-key-prop
↓get-cipher-stream-provider-prop
↓get-conjur-authentication-method-prop
↓get-connection-handler-prop
↓get-correlation-attribute-pair-prop
↓get-crypto-manager-prop
↓get-custom-logged-stats-prop
↓get-debug-target-prop
↓get-deployment-package-store-prop
↓get-dn-map-prop
↓get-error-template-prop
↓get-external-server-prop
↓get-failure-lockout-action-prop
↓get-gateway-api-endpoint-prop
↓get-gauge-data-source-prop
↓get-gauge-prop
↓get-global-configuration-prop
↓get-http-configuration-prop
↓get-http-servlet-cross-origin-policy-prop
↓get-http-servlet-extension-prop
↓get-id-token-validator-prop
↓get-identity-mapper-prop
↓get-impacted-attributes-provider-prop
↓get-inter-server-authentication-info-prop
↓get-key-manager-provider-prop
↓get-key-pair-prop
↓get-ldap-external-server-template-prop
↓get-ldap-health-check-prop
↓get-ldap-sdk-debug-logger-prop
↓get-license-prop
↓get-load-balancing-algorithm-prop
↓get-location-prop
↓get-log-file-rotation-listener-prop
↓get-log-publisher-prop
↓get-log-retention-policy-prop
↓get-log-rotation-policy-prop
↓get-mac-secret-key-prop
↓get-monitor-provider-prop
↓get-monitoring-endpoint-prop
↓get-obscured-value-prop
↓get-passphrase-provider-prop
↓get-password-policy-prop
↓get-password-storage-scheme-prop
↓get-plugin-prop
↓get-plugin-root-prop
↓get-policy-configuration-key-prop
↓get-policy-decision-service-prop
↓get-recurring-task-chain-prop
↓get-recurring-task-prop
↓get-root-dn-prop
↓get-root-dn-user-prop
↓get-sasl-mechanism-handler-prop
↓get-scim-attribute-prop
↓get-scim-resource-type-prop
↓get-scim-schema-prop
↓get-scim-sub-resource-type-handler-prop
↓get-scim-subattribute-prop
↓get-secondary-store-adapter-prop
↓get-server-group-prop
↓get-server-instance-listener-prop
↓get-server-instance-prop
↓get-sideband-api-endpoint-prop
↓get-sideband-api-shared-secret-prop
↓get-store-adapter-mapping-prop
↓get-store-adapter-plugin-prop
↓get-store-adapter-prop
↓get-token-claim-validation-prop
↓get-token-resource-lookup-method-prop
↓get-topology-admin-user-prop
↓get-trust-manager-provider-prop
↓get-trusted-certificate-prop
↓get-vault-authentication-method-prop
↓get-velocity-context-provider-prop
↓get-velocity-template-loader-prop
↓get-web-application-extension-prop
↓list-access-token-validators
↓list-advice
↓list-alert-handlers
↓list-authorization-policy-decision-shared-secrets
↓list-azure-authentication-methods
↓list-backends
↓list-certificate-mappers
↓list-cipher-secret-keys
↓list-cipher-stream-providers
↓list-conjur-authentication-methods
↓list-connection-handlers
↓list-correlation-attribute-pairs
↓list-custom-logged-stats
↓list-debug-targets
↓list-deployment-package-stores
↓list-dn-maps
↓list-error-templates
↓list-external-servers
↓list-failure-lockout-actions
↓list-gateway-api-endpoints
↓list-gauge-data-sources
↓list-gauges
↓list-http-servlet-cross-origin-policies
↓list-http-servlet-extensions
↓list-id-token-validators
↓list-identity-mappers
↓list-impacted-attributes-providers
↓list-inter-server-authentication-info
↓list-key-manager-providers
↓list-key-pairs
↓list-ldap-external-server-templates
↓list-ldap-health-checks
↓list-load-balancing-algorithms
↓list-locations
↓list-log-file-rotation-listeners
↓list-log-publishers
↓list-log-retention-policies
↓list-log-rotation-policies
↓list-mac-secret-keys
↓list-monitor-providers
↓list-monitoring-endpoints
↓list-obscured-values
↓list-passphrase-providers
↓list-password-policies
↓list-password-storage-schemes
↓list-plugins
↓list-policy-configuration-keys
↓list-properties
↓list-recurring-task-chains
↓list-recurring-tasks
↓list-root-dn-users
↓list-sasl-mechanism-handlers
↓list-scim-attributes
↓list-scim-resource-types
↓list-scim-schemas
↓list-scim-sub-resource-type-handlers
↓list-scim-subattributes
↓list-secondary-store-adapters
↓list-server-groups
↓list-server-instance-listeners
↓list-server-instances
↓list-sideband-api-endpoints
↓list-sideband-api-shared-secrets
↓list-store-adapter-mappings
↓list-store-adapter-plugins
↓list-store-adapters
↓list-token-claim-validations
↓list-token-resource-lookup-methods
↓list-topology-admin-users
↓list-trust-manager-providers
↓list-trusted-certificates
↓list-vault-authentication-methods
↓list-velocity-context-providers
↓list-velocity-template-loaders
↓list-web-application-extensions
↓set-access-control-handler-prop
↓set-access-token-validator-prop
↓set-advice-prop
↓set-alarm-manager-prop
↓set-alert-handler-prop
↓set-authorization-policy-decision-shared-secret-prop
↓set-azure-authentication-method-prop
↓set-backend-prop
↓set-certificate-mapper-prop
↓set-cipher-secret-key-prop
↓set-cipher-stream-provider-prop
↓set-conjur-authentication-method-prop
↓set-connection-handler-prop
↓set-correlation-attribute-pair-prop
↓set-crypto-manager-prop
↓set-custom-logged-stats-prop
↓set-debug-target-prop
↓set-deployment-package-store-prop
↓set-dn-map-prop
↓set-error-template-prop
↓set-external-server-prop
↓set-failure-lockout-action-prop
↓set-gateway-api-endpoint-prop
↓set-gauge-data-source-prop
↓set-gauge-prop
↓set-global-configuration-prop
↓set-http-configuration-prop
↓set-http-servlet-cross-origin-policy-prop
↓set-http-servlet-extension-prop
↓set-id-token-validator-prop
↓set-identity-mapper-prop
↓set-impacted-attributes-provider-prop
↓set-inter-server-authentication-info-prop
↓set-key-manager-provider-prop
↓set-key-pair-prop
↓set-ldap-external-server-template-prop
↓set-ldap-health-check-prop
↓set-ldap-sdk-debug-logger-prop
↓set-license-prop
↓set-load-balancing-algorithm-prop
↓set-location-prop
↓set-log-file-rotation-listener-prop
↓set-log-publisher-prop
↓set-log-retention-policy-prop
↓set-log-rotation-policy-prop
↓set-mac-secret-key-prop
↓set-monitor-provider-prop
↓set-monitoring-endpoint-prop
↓set-obscured-value-prop
↓set-passphrase-provider-prop
↓set-password-policy-prop
↓set-password-storage-scheme-prop
↓set-plugin-prop
↓set-plugin-root-prop
↓set-policy-configuration-key-prop
↓set-policy-decision-service-prop
↓set-recurring-task-chain-prop
↓set-recurring-task-prop
↓set-root-dn-prop
↓set-root-dn-user-prop
↓set-sasl-mechanism-handler-prop
↓set-scim-attribute-prop
↓set-scim-resource-type-prop
↓set-scim-schema-prop
↓set-scim-sub-resource-type-handler-prop
↓set-scim-subattribute-prop
↓set-secondary-store-adapter-prop
↓set-server-group-prop
↓set-server-instance-listener-prop
↓set-server-instance-prop
↓set-sideband-api-endpoint-prop
↓set-sideband-api-shared-secret-prop
↓set-store-adapter-mapping-prop
↓set-store-adapter-plugin-prop
↓set-store-adapter-prop
↓set-token-claim-validation-prop
↓set-token-resource-lookup-method-prop
↓set-topology-admin-user-prop
↓set-trust-manager-provider-prop
↓set-trusted-certificate-prop
↓set-vault-authentication-method-prop
↓set-velocity-context-provider-prop
↓set-velocity-template-loader-prop
↓set-web-application-extension-prop

create-access-token-validator

Create Access Token Validators

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

create-access-token-validator Arguments

--validator-name {name}

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

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Access Token Validator to create. The type value can be one of the following: external-api-gateway | jwt | mock | ping-federate | third-party

Required No

Multi-Valued No

create-advice

Create Advice

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

create-advice Arguments

--advice-name {name}

Description The name of the new Advice

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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 Advice to create. The type value can be one of the following: third-party

Required No

Multi-Valued No

create-alert-handler

Create Alert Handlers

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

create-alert-handler Arguments

--handler-name {name}

Description The name of the new Alert Handler

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-authorization-policy-decision-shared-secret

Create Authorization Policy Decision Shared Secrets

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

create-authorization-policy-decision-shared-secret Arguments

--secret-name {name}

Description The name of the new Authorization Policy Decision Shared Secret

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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-azure-authentication-method

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

create-azure-authentication-method Arguments

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

Create Backends

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

create-backend Arguments

--backend-name {STRING}

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

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Backend to create. The type value can be one of the following: custom

Required No

Multi-Valued No

create-certificate-mapper

Create Certificate Mappers

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

create-certificate-mapper Arguments

--mapper-name {name}

Description The name of the new Certificate Mapper

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-cipher-stream-provider

Create Cipher Stream Providers

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

create-cipher-stream-provider Arguments

--provider-name {name}

Description The name of the new Cipher Stream Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Cipher Stream Provider to create. The type value can be one of the following: amazon-key-management-service | amazon-secrets-manager | azure-key-vault | conjur | file-based | pkcs11 | third-party | vault | wait-for-passphrase

Required No

Multi-Valued No

create-conjur-authentication-method

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

create-conjur-authentication-method Arguments

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

Create Connection Handlers

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

create-connection-handler Arguments

--handler-name {name}

Description The name of the new Connection Handler

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Connection Handler to create. The type value can be one of the following: http | jmx | ldap | ldif

Required No

Multi-Valued No

create-correlation-attribute-pair

Create 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

create-correlation-attribute-pair Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

--pair-name {name}

Description The name of the new 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-custom-logged-stats

Create Custom Logged Stats

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

create-custom-logged-stats Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin

Required No

Multi-Valued No

--stats-name {name}

Description The name of the new Custom Logged Stats

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Custom Logged Stats to create. The type value can be one of the following: custom

Required No

Multi-Valued No

create-debug-target

Create Debug Targets

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

create-debug-target Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher

Required No

Multi-Valued No

--target-name {STRING_NAME}

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

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-deployment-package-store

Create Deployment Package Stores

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

create-deployment-package-store Arguments

--store-name {name}

Description The name of the new Deployment Package Store

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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 Deployment Package Store to create. The type value can be one of the following: azure | filesystem | s3

Required No

Multi-Valued No

create-dn-map

Create DN Maps

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

create-dn-map Arguments

--map-name {name}

Description The name of the new DN Map

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-error-template

Create Error Templates

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

create-error-template Arguments

--template-name {name}

Description The name of the new Error Template

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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-external-server

Create External Servers

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

create-external-server Arguments

--server-name {name}

Description The name of the new External Server

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of External Server to create. The type value can be one of the following: active-directory | amazon-aws | api | conjur | consent-service | http | ldap | nokia-ds | nokia-proxy-server | opendj | oracle-unified-directory | ping-identity-ds | ping-identity-proxy-server | ping-one-http | policy | smtp | sun-ds | syslog | vault

Required No

Multi-Valued No

create-failure-lockout-action

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

create-failure-lockout-action Arguments

--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-gateway-api-endpoint

Create Gateway API Endpoints

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

create-gateway-api-endpoint Arguments

--endpoint-name {name}

Description The name of the new Gateway API 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

create-gauge

Create Gauges

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

create-gauge Arguments

--gauge-name {name}

Description The name of the new Gauge

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Gauge to create. The type value can be one of the following: indicator | numeric

Required No

Multi-Valued No

create-gauge-data-source

Create Gauge Data Sources

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

create-gauge-data-source Arguments

--source-name {name}

Description The name of the new Gauge Data Source

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-http-servlet-cross-origin-policy

Create HTTP Servlet Cross Origin Policies

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

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

--policy-name {name}

Description The name of the new HTTP Servlet Cross Origin Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-http-servlet-extension

Create HTTP Servlet Extensions

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

create-http-servlet-extension Arguments

--extension-name {name}

Description The name of the new HTTP Servlet Extension

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of HTTP Servlet Extension to create. The type value can be one of the following: availability-state | file-server | gateway | groovy-scripted | third-party

Required No

Multi-Valued No

create-id-token-validator

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

create-id-token-validator Arguments

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

Create Identity Mappers

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

create-identity-mapper Arguments

--mapper-name {name}

Description The name of the new Identity Mapper

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-impacted-attributes-provider

Create Impacted Attributes Providers

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

create-impacted-attributes-provider Arguments

--provider-name {name}

Description The name of the new Impacted Attributes 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 Impacted Attributes Provider to create. The type value can be one of the following: scim

Required No

Multi-Valued No

create-key-manager-provider

Create Key Manager Providers

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

create-key-manager-provider Arguments

--provider-name {name}

Description The name of the new Key Manager Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-key-pair

Create Key Pairs

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

create-key-pair Arguments

--pair-name {name}

Description The name of the new Key Pair

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-ldap-external-server-template

Create LDAP External Server Templates

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

create-ldap-external-server-template Arguments

--template-name {name}

Description The name of the new LDAP External Server Template

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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-health-check

Create LDAP Health Checks

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

create-ldap-health-check Arguments

--check-name {name}

Description The name of the new LDAP Health Check

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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 LDAP Health Check to create. The type value can be one of the following: admin-alert | custom | groovy-scripted | replication-backlog | search | third-party | work-queue-busyness

Required No

Multi-Valued No

create-load-balancing-algorithm

Create Load Balancing Algorithms

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

create-load-balancing-algorithm Arguments

--algorithm-name {name}

Description The name of the new Load Balancing Algorithm

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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 Load Balancing Algorithm to create. The type value can be one of the following: failover | fewest-operations

Required No

Multi-Valued No

create-location

Create Locations

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

create-location Arguments

--location-name {name}

Description The name of the new Location

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-log-file-rotation-listener

Create Log File Rotation Listeners

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

create-log-file-rotation-listener Arguments

--listener-name {name}

Description The name of the new Log File Rotation Listener

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-log-publisher

Create Log Publishers

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

create-log-publisher Arguments

--publisher-name {name}

Description The name of the new Log Publisher

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Log Publisher to create. The type value can be one of the following: common-log-file-http-operation | console-json-audit | debug-access | file-based-access | file-based-audit | file-based-debug | file-based-error | file-based-json-audit | file-based-policy-decision | file-based-trace | groovy-scripted-access | groovy-scripted-error | groovy-scripted-file-based-access | groovy-scripted-file-based-error | groovy-scripted-http-operation | json-access | json-error | syslog-based-access | syslog-based-error | syslog-json-access | syslog-json-audit | syslog-json-error | 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-policy

Create Log Retention Policies

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

create-log-retention-policy Arguments

--policy-name {name}

Description The name of the new Log Retention Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-log-rotation-policy

Create Log Rotation Policies

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

create-log-rotation-policy Arguments

--policy-name {name}

Description The name of the new Log Rotation Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-monitor-provider

Create Monitor Providers

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

create-monitor-provider Arguments

--provider-name {name}

Description The name of the new Monitor Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Monitor Provider to create. The type value can be one of the following: custom | third-party

Required No

Multi-Valued No

create-monitoring-endpoint

Create Monitoring Endpoints

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

create-monitoring-endpoint Arguments

--endpoint-name {name}

Description The name of the new Monitoring Endpoint

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Monitoring Endpoint to create. The type value can be one of the following: statsd

Required No

Multi-Valued No

create-obscured-value

Create Obscured Values

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

create-obscured-value Arguments

--value-name {name}

Description The name of the new Obscured Value

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-passphrase-provider

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

create-passphrase-provider Arguments

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

Create Password Policies

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

create-password-policy Arguments

--policy-name {name}

Description The name of the new Password Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-password-storage-scheme

Create Password Storage Schemes

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

create-password-storage-scheme Arguments

--scheme-name {name}

Description The name of the new Password Storage Scheme

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Password Storage Scheme to create. The type value can be one of the following: aes-256 | amazon-secrets-manager | argon2 | azure-key-vault | bcrypt | conjur | crypt | pbkdf2 | scrypt | third-party | third-party-enhanced | vault

Required No

Multi-Valued No

create-plugin

Create Plugins

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

create-plugin Arguments

--plugin-name {name}

Description The name of the new Plugin

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Plugin to create. The type value can be one of the following: custom | groovy-scripted | modifiable-password-policy-state | periodic-stats-logger | search-shutdown | seven-bit-clean | snmp-subagent | third-party

Required No

Multi-Valued No

create-policy-configuration-key

Create Policy Configuration Keys

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

create-policy-configuration-key Arguments

--key-name {name}

Description The name of the new Policy Configuration Key

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-recurring-task

Create Recurring Tasks

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

create-recurring-task Arguments

--task-name {name}

Description The name of the new Recurring Task

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Recurring Task to create. The type value can be one of the following: backup | 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-chain

Create Recurring Task Chains

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

create-recurring-task-chain Arguments

--chain-name {name}

Description The name of the new Recurring Task Chain

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-root-dn-user

Create Root DN Users

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

create-root-dn-user Arguments

--user-name {name}

Description The name of the new Root DN User

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-sasl-mechanism-handler

Create SASL Mechanism Handlers

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

create-sasl-mechanism-handler Arguments

--handler-name {name}

Description The name of the new SASL Mechanism Handler

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of SASL Mechanism Handler to create. The type value can be one of the following: oauth-bearer | third-party

Required No

Multi-Valued No

create-scim-attribute

Create SCIM Attributes

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

create-scim-attribute Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {attribute-name}

Description The name of the new SCIM Attribute which will also be used as the value of the 'name' property. The name of the attribute.

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-scim-resource-type

Create SCIM Resource Types

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

create-scim-resource-type Arguments

--type-name {name}

Description The name of the new SCIM Resource Type

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-scim-schema

Create SCIM Schemas

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

create-scim-schema Arguments

--schema-name {urn}

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

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-scim-sub-resource-type-handler

Create SCIM Sub Resource Type Handlers

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

create-scim-sub-resource-type-handler Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--handler-name {name}

Description The name of the new SCIM Sub Resource Type 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 SCIM Sub Resource Type Handler to create. The type value can be one of the following: third-party

Required No

Multi-Valued No

create-scim-subattribute

Create SCIM Subattributes

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

create-scim-subattribute Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

--subattribute-name {name}

Description The name of the new SCIM Subattribute

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-secondary-store-adapter

Create Secondary Store Adapters

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

create-secondary-store-adapter Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the new Secondary Store Adapter

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-server-group

Create Server Groups

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

create-server-group Arguments

--group-name {name}

Description The name of the new Server Group

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-sideband-api-endpoint

Create Sideband API Endpoints

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

create-sideband-api-endpoint Arguments

--endpoint-name {name}

Description The name of the new Sideband API 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

create-sideband-api-shared-secret

Create Sideband API Shared Secrets

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

create-sideband-api-shared-secret Arguments

--secret-name {name}

Description The name of the new Sideband API Shared Secret

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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-store-adapter

Create Store Adapters

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

create-store-adapter Arguments

--adapter-name {urn-component}

Description The name of the new Store Adapter which will also be used as the value of the 'name' property. The name of the Store Adapter. The name must be valid as a component of a URN.

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE 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 Store Adapter to create. The type value can be one of the following: ldap | third-party

Required No

Multi-Valued No

create-store-adapter-mapping

Create Store Adapter Mappings

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

create-store-adapter-mapping Arguments

--type-name {name}

Description The name of the Mapping SCIM Resource Type

Required No

Multi-Valued No

--mapping-name {name}

Description The name of the new Store Adapter 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-store-adapter-plugin

Create Store Adapter Plugins

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

create-store-adapter-plugin Arguments

--plugin-name {name}

Description The name of the new Store Adapter 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 Store Adapter Plugin to create. The type value can be one of the following: third-party

Required No

Multi-Valued No

create-token-claim-validation

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

create-token-claim-validation Arguments

--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-token-resource-lookup-method

Create Token Resource Lookup Methods

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

create-token-resource-lookup-method Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

--method-name {name}

Description The name of the new Token Resource Lookup 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 Token Resource Lookup Method to create. The type value can be one of the following: scim | third-party

Required No

Multi-Valued No

create-topology-admin-user

Create Topology Admin Users

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

create-topology-admin-user Arguments

--user-name {name}

Description The name of the new Topology Admin User

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-trust-manager-provider

Create Trust Manager Providers

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

create-trust-manager-provider Arguments

--provider-name {name}

Description The name of the new Trust Manager Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Trust Manager Provider to create. The type value can be one of the following: blind | file-based | jvm-default | third-party

Required No

Multi-Valued No

create-trusted-certificate

Create Trusted Certificates

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

create-trusted-certificate Arguments

--certificate-name {name}

Description The name of the new Trusted Certificate

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-vault-authentication-method

Create Vault Authentication Methods

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

create-vault-authentication-method Arguments

--method-name {name}

Description The name of the new Vault Authentication Method

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

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

Required No

Multi-Valued No

create-velocity-context-provider

Create Velocity Context Providers

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

create-velocity-context-provider Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--provider-name {name}

Description The name of the new Velocity Context Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

-t {type}
--type {type}

Description The type of Velocity Context Provider to create. The type value can be one of the following: custom | third-party | velocity-tools

Required No

Multi-Valued No

create-velocity-template-loader

Create Velocity Template Loaders

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

create-velocity-template-loader Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--loader-name {name}

Description The name of the new Velocity Template Loader

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

create-web-application-extension

Create Web Application Extensions

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

create-web-application-extension Arguments

--extension-name {name}

Description The name of the new Web Application Extension

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

delete-access-token-validator

Delete Access Token Validators

delete-access-token-validator Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Access Token Validators

delete-advice

Delete Advice

delete-advice Arguments

--advice-name {name}

Description The name of the Advice

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Advice

delete-alert-handler

Delete Alert Handlers

delete-alert-handler Arguments

--handler-name {name}

Description The name of the Alert Handler

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Alert Handlers

delete-authorization-policy-decision-shared-secret

Delete Authorization Policy Decision Shared Secrets

delete-authorization-policy-decision-shared-secret Arguments

--secret-name {name}

Description The name of the Authorization Policy Decision Shared Secret

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Authorization Policy Decision Shared Secrets

delete-azure-authentication-method

Delete Azure Authentication Methods

delete-azure-authentication-method Arguments

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

Delete Backends

delete-backend Arguments

--backend-name {name}

Description The name of the Backend

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Backends

delete-certificate-mapper

Delete Certificate Mappers

delete-certificate-mapper Arguments

--mapper-name {name}

Description The name of the Certificate Mapper

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Certificate Mappers

delete-cipher-stream-provider

Delete Cipher Stream Providers

delete-cipher-stream-provider Arguments

--provider-name {name}

Description The name of the Cipher Stream Provider

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Cipher Stream Providers

delete-conjur-authentication-method

Delete Conjur Authentication Methods

delete-conjur-authentication-method Arguments

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

Delete Connection Handlers

delete-connection-handler Arguments

--handler-name {name}

Description The name of the Connection Handler

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Connection Handlers

delete-correlation-attribute-pair

Delete Correlation Attribute Pairs

delete-correlation-attribute-pair Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

--pair-name {name}

Description The name of the Correlation Attribute Pair

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Correlation Attribute Pairs

delete-custom-logged-stats

Delete Custom Logged Stats

delete-custom-logged-stats Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin

Required No

Multi-Valued No

--stats-name {name}

Description The name of the Custom Logged Stats

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Custom Logged Stats

delete-debug-target

Delete Debug Targets

delete-debug-target Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher

Required No

Multi-Valued No

--target-name {name}

Description The name of the Debug Target

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Debug Targets

delete-deployment-package-store

Delete Deployment Package Stores

delete-deployment-package-store Arguments

--store-name {name}

Description The name of the Deployment Package Store

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Deployment Package Stores

delete-dn-map

Delete DN Maps

delete-dn-map Arguments

--map-name {name}

Description The name of the DN Map

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent DN Maps

delete-error-template

Delete Error Templates

delete-error-template Arguments

--template-name {name}

Description The name of the Error Template

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Error Templates

delete-external-server

Delete External Servers

delete-external-server Arguments

--server-name {name}

Description The name of the External Server

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent External Servers

delete-failure-lockout-action

Delete Failure Lockout Actions

delete-failure-lockout-action Arguments

--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-gateway-api-endpoint

Delete Gateway API Endpoints

delete-gateway-api-endpoint Arguments

--endpoint-name {name}

Description The name of the Gateway API Endpoint

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Gateway API Endpoints

delete-gauge

Delete Gauges

delete-gauge Arguments

--gauge-name {name}

Description The name of the Gauge

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Gauges

delete-gauge-data-source

Delete Gauge Data Sources

delete-gauge-data-source Arguments

--source-name {name}

Description The name of the Gauge Data Source

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Gauge Data Sources

delete-http-servlet-cross-origin-policy

Delete HTTP Servlet Cross Origin Policies

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

--policy-name {name}

Description The name of the HTTP Servlet Cross Origin Policy

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent HTTP Servlet Cross Origin Policies

delete-http-servlet-extension

Delete HTTP Servlet Extensions

delete-http-servlet-extension Arguments

--extension-name {name}

Description The name of the HTTP Servlet Extension

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent HTTP Servlet Extensions

delete-id-token-validator

Delete ID Token Validators

delete-id-token-validator Arguments

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

Delete Identity Mappers

delete-identity-mapper Arguments

--mapper-name {name}

Description The name of the Identity Mapper

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Identity Mappers

delete-impacted-attributes-provider

Delete Impacted Attributes Providers

delete-impacted-attributes-provider Arguments

--provider-name {name}

Description The name of the Impacted Attributes Provider

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Impacted Attributes Providers

delete-key-manager-provider

Delete Key Manager Providers

delete-key-manager-provider Arguments

--provider-name {name}

Description The name of the Key Manager Provider

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Key Manager Providers

delete-key-pair

Delete Key Pairs

delete-key-pair Arguments

--pair-name {name}

Description The name of the Key Pair

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Key Pairs

delete-ldap-external-server-template

Delete LDAP External Server Templates

delete-ldap-external-server-template Arguments

--template-name {name}

Description The name of the LDAP External Server Template

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent LDAP External Server Templates

delete-ldap-health-check

Delete LDAP Health Checks

delete-ldap-health-check Arguments

--check-name {name}

Description The name of the LDAP Health Check

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent LDAP Health Checks

delete-load-balancing-algorithm

Delete Load Balancing Algorithms

delete-load-balancing-algorithm Arguments

--algorithm-name {name}

Description The name of the Load Balancing Algorithm

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Load Balancing Algorithms

delete-location

Delete Locations

delete-location Arguments

--location-name {name}

Description The name of the Location

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Locations

delete-log-file-rotation-listener

Delete Log File Rotation Listeners

delete-log-file-rotation-listener Arguments

--listener-name {name}

Description The name of the Log File Rotation Listener

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Log File Rotation Listeners

delete-log-publisher

Delete Log Publishers

delete-log-publisher Arguments

--publisher-name {name}

Description The name of the Log Publisher

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Log Publishers

delete-log-retention-policy

Delete Log Retention Policies

delete-log-retention-policy Arguments

--policy-name {name}

Description The name of the Log Retention Policy

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Log Retention Policies

delete-log-rotation-policy

Delete Log Rotation Policies

delete-log-rotation-policy Arguments

--policy-name {name}

Description The name of the Log Rotation Policy

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Log Rotation Policies

delete-monitor-provider

Delete Monitor Providers

delete-monitor-provider Arguments

--provider-name {name}

Description The name of the Monitor Provider

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Monitor Providers

delete-monitoring-endpoint

Delete Monitoring Endpoints

delete-monitoring-endpoint Arguments

--endpoint-name {name}

Description The name of the Monitoring Endpoint

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Monitoring Endpoints

delete-obscured-value

Delete Obscured Values

delete-obscured-value Arguments

--value-name {name}

Description The name of the Obscured Value

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Obscured Values

delete-passphrase-provider

Delete Passphrase Providers

delete-passphrase-provider Arguments

--provider-name {name}

Description The name of the Passphrase Provider

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Passphrase Providers

delete-password-policy

Delete Password Policies

delete-password-policy Arguments

--policy-name {name}

Description The name of the Password Policy

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Password Policies

delete-password-storage-scheme

Delete Password Storage Schemes

delete-password-storage-scheme Arguments

--scheme-name {name}

Description The name of the Password Storage Scheme

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Password Storage Schemes

delete-plugin

Delete Plugins

delete-plugin Arguments

--plugin-name {name}

Description The name of the Plugin

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Plugins

delete-policy-configuration-key

Delete Policy Configuration Keys

delete-policy-configuration-key Arguments

--key-name {name}

Description The name of the Policy Configuration Key

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Policy Configuration Keys

delete-recurring-task

Delete Recurring Tasks

delete-recurring-task Arguments

--task-name {name}

Description The name of the Recurring Task

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Recurring Tasks

delete-recurring-task-chain

Delete Recurring Task Chains

delete-recurring-task-chain Arguments

--chain-name {name}

Description The name of the Recurring Task Chain

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Recurring Task Chains

delete-root-dn-user

Delete Root DN Users

delete-root-dn-user Arguments

--user-name {name}

Description The name of the Root DN User

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Root DN Users

delete-sasl-mechanism-handler

Delete SASL Mechanism Handlers

delete-sasl-mechanism-handler Arguments

--handler-name {name}

Description The name of the SASL Mechanism Handler

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent SASL Mechanism Handlers

delete-scim-attribute

Delete SCIM Attributes

delete-scim-attribute Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Attributes

delete-scim-resource-type

Delete SCIM Resource Types

delete-scim-resource-type Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Resource Types

delete-scim-schema

Delete SCIM Schemas

delete-scim-schema Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Schemas

delete-scim-sub-resource-type-handler

Delete SCIM Sub Resource Type Handlers

delete-scim-sub-resource-type-handler Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--handler-name {name}

Description The name of the SCIM Sub Resource Type Handler

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Sub Resource Type Handlers

delete-scim-subattribute

Delete SCIM Subattributes

delete-scim-subattribute Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

--subattribute-name {name}

Description The name of the SCIM Subattribute

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Subattributes

delete-secondary-store-adapter

Delete Secondary Store Adapters

delete-secondary-store-adapter Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Secondary Store Adapters

delete-server-group

Delete Server Groups

delete-server-group Arguments

--group-name {name}

Description The name of the Server Group

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Server Groups

delete-sideband-api-endpoint

Delete Sideband API Endpoints

delete-sideband-api-endpoint Arguments

--endpoint-name {name}

Description The name of the Sideband API Endpoint

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Sideband API Endpoints

delete-sideband-api-shared-secret

Delete Sideband API Shared Secrets

delete-sideband-api-shared-secret Arguments

--secret-name {name}

Description The name of the Sideband API Shared Secret

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Sideband API Shared Secrets

delete-store-adapter

Delete Store Adapters

delete-store-adapter Arguments

--adapter-name {name}

Description The name of the Store Adapter

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Store Adapters

delete-store-adapter-mapping

Delete Store Adapter Mappings

delete-store-adapter-mapping Arguments

--type-name {name}

Description The name of the Mapping SCIM Resource Type

Required No

Multi-Valued No

--mapping-name {name}

Description The name of the Store Adapter Mapping

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Store Adapter Mappings

delete-store-adapter-plugin

Delete Store Adapter Plugins

delete-store-adapter-plugin Arguments

--plugin-name {name}

Description The name of the Store Adapter Plugin

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Store Adapter Plugins

delete-token-claim-validation

Delete Token Claim Validations

delete-token-claim-validation Arguments

--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-token-resource-lookup-method

Delete Token Resource Lookup Methods

delete-token-resource-lookup-method Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

--method-name {name}

Description The name of the Token Resource Lookup Method

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Token Resource Lookup Methods

delete-topology-admin-user

Delete Topology Admin Users

delete-topology-admin-user Arguments

--user-name {name}

Description The name of the Topology Admin User

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Topology Admin Users

delete-trust-manager-provider

Delete Trust Manager Providers

delete-trust-manager-provider Arguments

--provider-name {name}

Description The name of the Trust Manager Provider

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Trust Manager Providers

delete-trusted-certificate

Delete Trusted Certificates

delete-trusted-certificate Arguments

--certificate-name {name}

Description The name of the Trusted Certificate

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Trusted Certificates

delete-vault-authentication-method

Delete Vault Authentication Methods

delete-vault-authentication-method Arguments

--method-name {name}

Description The name of the Vault Authentication Method

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Vault Authentication Methods

delete-velocity-context-provider

Delete Velocity Context Providers

delete-velocity-context-provider Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--provider-name {name}

Description The name of the Velocity Context Provider

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Velocity Context Providers

delete-velocity-template-loader

Delete Velocity Template Loaders

delete-velocity-template-loader Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--loader-name {name}

Description The name of the Velocity Template Loader

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Velocity Template Loaders

delete-web-application-extension

Delete Web Application Extensions

delete-web-application-extension Arguments

--extension-name {name}

Description The name of the Web Application Extension

Required No

Multi-Valued No

-f
--force

Description Ignore nonexistent Web Application Extensions

get-access-control-handler-prop

Show Access Control Handler properties

get-access-control-handler-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Access Control Handler or one of its subcomponents DSEE Compat Access Control Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-access-token-validator-prop

Show Access Token Validator properties

get-access-token-validator-prop Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

get-advice-prop

Show Advice properties

get-advice-prop Arguments

--advice-name {name}

Description The name of the Advice

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Advice or one of its subcomponents Add Filter Advice, Combine SCIM Search Authorizations Advice, Denied Reason Advice, Exclude Attributes Advice, Filter Response Advice, Include Attributes Advice, Modify Attributes Advice, Modify Headers Advice, Modify Query Advice, Modify SCIM Patch Advice, Regex Replace Attributes Advice, Third Party Advice in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-alarm-manager-prop

Show Alarm Manager properties

get-alarm-manager-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Alarm Manager in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-alert-handler-prop

Show Alert Handler properties

get-alert-handler-prop Arguments

--handler-name {name}

Description The name of the Alert Handler

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

get-authorization-policy-decision-shared-secret-prop

Show Authorization Policy Decision Shared Secret properties

get-authorization-policy-decision-shared-secret-prop Arguments

--secret-name {name}

Description The name of the Authorization Policy Decision Shared Secret

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Authorization Policy Decision Shared Secret in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-azure-authentication-method-prop

Show Azure Authentication Method properties

get-azure-authentication-method-prop Arguments

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

See 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

get-backend-prop

Show Backend properties

get-backend-prop Arguments

--backend-name {name}

Description The name of the Backend

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-certificate-mapper-prop

Show Certificate Mapper properties

get-certificate-mapper-prop Arguments

--mapper-name {name}

Description The name of the Certificate Mapper

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-cipher-secret-key-prop

Show Cipher Secret Key properties

get-cipher-secret-key-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--key-name {name}

Description The name of the Cipher Secret Key

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-cipher-stream-provider-prop

Show Cipher Stream Provider properties

get-cipher-stream-provider-prop Arguments

--provider-name {name}

Description The name of the Cipher Stream Provider

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, 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

get-conjur-authentication-method-prop

Show Conjur Authentication Method properties

get-conjur-authentication-method-prop Arguments

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

See 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

get-connection-handler-prop

Show Connection Handler properties

get-connection-handler-prop Arguments

--handler-name {name}

Description The name of the Connection Handler

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Connection Handler or one of its subcomponents HTTP Connection Handler, JMX Connection Handler, LDAP Connection Handler, LDIF Connection Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-correlation-attribute-pair-prop

Show Correlation Attribute Pair properties

get-correlation-attribute-pair-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

--pair-name {name}

Description The name of the Correlation Attribute Pair

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

get-crypto-manager-prop

Show Crypto Manager properties

get-crypto-manager-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Crypto Manager in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-custom-logged-stats-prop

Show Custom Logged Stats properties

get-custom-logged-stats-prop Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin

Required No

Multi-Valued No

--stats-name {name}

Description The name of the Custom Logged Stats

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Custom Logged Stats in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-debug-target-prop

Show Debug Target properties

get-debug-target-prop Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher

Required No

Multi-Valued No

--target-name {name}

Description The name of the Debug Target

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Debug Target in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-deployment-package-store-prop

Show Deployment Package Store properties

get-deployment-package-store-prop Arguments

--store-name {name}

Description The name of the Deployment Package Store

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Deployment Package Store or one of its subcomponents Azure Deployment Package Store, Filesystem Deployment Package Store, S3 Deployment Package Store in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-dn-map-prop

Show DN Map properties

get-dn-map-prop Arguments

--map-name {name}

Description The name of the DN Map

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for DN Map in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-error-template-prop

Show Error Template properties

get-error-template-prop Arguments

--template-name {name}

Description The name of the Error Template

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Error Template in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-external-server-prop

Show External Server properties

get-external-server-prop Arguments

--server-name {name}

Description The name of the External Server

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

get-failure-lockout-action-prop

Show Failure Lockout Action properties

get-failure-lockout-action-prop Arguments

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

See 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

get-gateway-api-endpoint-prop

Show Gateway API Endpoint properties

get-gateway-api-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Gateway API Endpoint

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-gauge-data-source-prop

Show Gauge Data Source properties

get-gauge-data-source-prop Arguments

--source-name {name}

Description The name of the Gauge Data Source

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Gauge Data Source or one of its subcomponents Indicator Gauge Data Source, Numeric Gauge Data Source in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-gauge-prop

Show Gauge properties

get-gauge-prop Arguments

--gauge-name {name}

Description The name of the Gauge

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Gauge or one of its subcomponents Indicator Gauge, Numeric Gauge in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-global-configuration-prop

Show Global Configuration properties

get-global-configuration-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Global Configuration in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-http-configuration-prop

Show HTTP Configuration properties

get-http-configuration-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Configuration in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

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

Show HTTP Servlet Cross Origin Policy properties

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

--policy-name {name}

Description The name of the HTTP Servlet Cross Origin Policy

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Cross Origin Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-http-servlet-extension-prop

Show HTTP Servlet Extension properties

get-http-servlet-extension-prop Arguments

--extension-name {name}

Description The name of the HTTP Servlet Extension

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-id-token-validator-prop

Show ID Token Validator properties

get-id-token-validator-prop Arguments

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

See 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

get-identity-mapper-prop

Show Identity Mapper properties

get-identity-mapper-prop Arguments

--mapper-name {name}

Description The name of the Identity Mapper

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Identity Mapper or one of its subcomponents Aggregate 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

get-impacted-attributes-provider-prop

Show Impacted Attributes Provider properties

get-impacted-attributes-provider-prop Arguments

--provider-name {name}

Description The name of the Impacted Attributes Provider

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Impacted Attributes Provider or one of its subcomponents SCIM Impacted Attributes Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-inter-server-authentication-info-prop

Show Inter Server Authentication Info properties

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

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--listener-name {name}

Description The name of the Server Instance Listener

Required No

Multi-Valued No

--info-name {name}

Description The name of the Inter Server Authentication Info

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Inter Server Authentication Info or one of its subcomponents Certificate Inter Server Authentication Info, Password Inter Server Authentication Info in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-key-manager-provider-prop

Show Key Manager Provider properties

get-key-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Key Manager Provider

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, PKCS11 Key Manager Provider, Third Party Key Manager Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-key-pair-prop

Show Key Pair properties

get-key-pair-prop Arguments

--pair-name {name}

Description The name of the Key Pair

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Key Pair in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-ldap-external-server-template-prop

Show LDAP External Server Template properties

get-ldap-external-server-template-prop Arguments

--template-name {name}

Description The name of the LDAP External Server Template

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for LDAP External Server Template in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-ldap-health-check-prop

Show LDAP Health Check properties

get-ldap-health-check-prop Arguments

--check-name {name}

Description The name of the LDAP Health Check

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for LDAP Health Check or one of its subcomponents Admin Alert LDAP Health Check, Scripted LDAP Health Check, Replication Backlog LDAP Health Check, Search LDAP Health Check, Third Party LDAP Health Check, Work Queue Busyness LDAP Health Check in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-ldap-sdk-debug-logger-prop

Show LDAP SDK Debug Logger properties

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

--property {property}

Description The name of a property to be displayed.

See properties for LDAP SDK Debug Logger in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-license-prop

Show License properties

get-license-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for License in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-load-balancing-algorithm-prop

Show Load Balancing Algorithm properties

get-load-balancing-algorithm-prop Arguments

--algorithm-name {name}

Description The name of the Load Balancing Algorithm

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Load Balancing Algorithm or one of its subcomponents Location Based Load Balancing Algorithm, Single Server Load Balancing Algorithm, Weighted Load Balancing Algorithm in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-location-prop

Show Location properties

get-location-prop Arguments

--location-name {name}

Description The name of the Location

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Location in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-log-file-rotation-listener-prop

Show Log File Rotation Listener properties

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

--listener-name {name}

Description The name of the Log File Rotation Listener

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Log File Rotation Listener or one of its subcomponents Copy Log File Rotation Listener, Summarize Log File Rotation Listener, Third Party Log File Rotation Listener in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-log-publisher-prop

Show Log Publisher properties

get-log-publisher-prop Arguments

--publisher-name {name}

Description The name of the Log Publisher

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Log Publisher or one of its subcomponents Access Log Publisher, HTTP Operation Log Publisher, Error Log Publisher, Sync Log Publisher, Debug Log Publisher, Policy Decision Log Publisher, Trace Log Publisher in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-log-retention-policy-prop

Show Log Retention Policy properties

get-log-retention-policy-prop Arguments

--policy-name {name}

Description The name of the Log Retention Policy

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Log Retention Policy or one of its subcomponents File Count Log Retention Policy, Free Disk Space Log Retention Policy, Never Delete Log Retention Policy, Size Limit Log Retention Policy, Time Limit Log Retention Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-log-rotation-policy-prop

Show Log Rotation Policy properties

get-log-rotation-policy-prop Arguments

--policy-name {name}

Description The name of the Log Rotation Policy

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-mac-secret-key-prop

Show Mac Secret Key properties

get-mac-secret-key-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--key-name {name}

Description The name of the Mac Secret Key

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-monitor-provider-prop

Show Monitor Provider properties

get-monitor-provider-prop Arguments

--provider-name {name}

Description The name of the Monitor Provider

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Entry Cache Monitor Provider, 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

get-monitoring-endpoint-prop

Show Monitoring Endpoint properties

get-monitoring-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Monitoring Endpoint

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Monitoring Endpoint or one of its subcomponents StatsD Monitoring Endpoint in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-obscured-value-prop

Show Obscured Value properties

get-obscured-value-prop Arguments

--value-name {name}

Description The name of the Obscured Value

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Obscured Value in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-passphrase-provider-prop

Show Passphrase Provider properties

get-passphrase-provider-prop Arguments

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

See 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

get-password-policy-prop

Show Password Policy properties

get-password-policy-prop Arguments

--policy-name {name}

Description The name of the Password Policy

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Password Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-password-storage-scheme-prop

Show Password Storage Scheme properties

get-password-storage-scheme-prop Arguments

--scheme-name {name}

Description The name of the Password Storage Scheme

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Password Storage Scheme or one of its subcomponents AES 256 Password Storage Scheme, AES Password Storage Scheme, Amazon Secrets Manager Password Storage Scheme, Argon2 Password Storage Scheme, Azure Key Vault Password Storage Scheme, Base64 Password Storage Scheme, Bcrypt Password Storage Scheme, Blowfish Password Storage Scheme, Clear Password Storage Scheme, Conjur Password Storage Scheme, Crypt Password Storage Scheme, MD5 Password Storage Scheme, PBKDF2 Password Storage Scheme, RC4 Password Storage Scheme, SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted SHA256 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA512 Password Storage Scheme, Scrypt Password Storage Scheme, Third Party Enhanced Password Storage Scheme, Third Party Password Storage Scheme, Triple DES Password Storage Scheme, Vault Password Storage Scheme in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-plugin-prop

Show Plugin properties

get-plugin-prop Arguments

--plugin-name {name}

Description The name of the Plugin

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Plugin or one of its subcomponents Attribute Mapper Plugin, Change Subscription Notification Plugin, Changelog Password Encryption Plugin, Purge Expired Data Plugin, Composed Attribute Plugin, DN Mapper Plugin, Delay Plugin, Encrypt Attribute Values Plugin, Entry UUID Plugin, Global Referential Integrity Plugin, Globally Unique Attribute Plugin, Scripted Plugin, Internal Search Rate Plugin, LDAP Attribute Description List Plugin, LDAP Result Code Tracker Plugin, Last Access Time Plugin, Last Mod Plugin, Modifiable Password Policy State Plugin, Monitor History Plugin, Pass Through Authentication Plugin, Password Policy Import Plugin, Periodic GC Plugin, Stats Plugin, PingOne Pass Through Authentication Plugin, Pluggable Pass Through Authentication Plugin, Pre Update Config Plugin, Processing Time Histogram Plugin, Profiler Plugin, Referential Integrity Plugin, Referral On Update Plugin, SNMP Master Agent Plugin, SNMP Subagent Plugin, Search Shutdown Plugin, Secret Key Delete Alert Plugin, Seven Bit Clean Plugin, Simple To External Bind Plugin, Sub Operation Timing Plugin, Third Party Plugin, Unique Attribute Plugin in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-plugin-root-prop

Show Plugin Root properties

get-plugin-root-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Plugin Root in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-policy-configuration-key-prop

Show Policy Configuration Key properties

get-policy-configuration-key-prop Arguments

--key-name {name}

Description The name of the Policy Configuration Key

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Policy Configuration Key in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-policy-decision-service-prop

Show Policy Decision Service properties

get-policy-decision-service-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Policy Decision Service in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-recurring-task-chain-prop

Show Recurring Task Chain properties

get-recurring-task-chain-prop Arguments

--chain-name {name}

Description The name of the Recurring Task Chain

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task Chain in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-recurring-task-prop

Show Recurring Task properties

get-recurring-task-prop Arguments

--task-name {name}

Description The name of the Recurring Task

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task or one of its subcomponents Backup Recurring Task, 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

get-root-dn-prop

Show Root DN properties

get-root-dn-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Root DN in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-root-dn-user-prop

Show Root DN User properties

get-root-dn-user-prop Arguments

--user-name {name}

Description The name of the Root DN User

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-sasl-mechanism-handler-prop

Show SASL Mechanism Handler properties

get-sasl-mechanism-handler-prop Arguments

--handler-name {name}

Description The name of the SASL Mechanism Handler

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SASL Mechanism Handler or one of its subcomponents Anonymous SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler, External SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, 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

get-scim-attribute-prop

Show SCIM Attribute properties

get-scim-attribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Attribute in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-scim-resource-type-prop

Show SCIM Resource Type properties

get-scim-resource-type-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Resource Type or one of its subcomponents Mapping SCIM Resource Type, Pass Through SCIM Resource Type in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-scim-schema-prop

Show SCIM Schema properties

get-scim-schema-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Schema in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-scim-sub-resource-type-handler-prop

Show SCIM Sub Resource Type Handler properties

get-scim-sub-resource-type-handler-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--handler-name {name}

Description The name of the SCIM Sub Resource Type Handler

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Sub Resource Type Handler or one of its subcomponents Third Party SCIM Sub Resource Type Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-scim-subattribute-prop

Show SCIM Subattribute properties

get-scim-subattribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

--subattribute-name {name}

Description The name of the SCIM Subattribute

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Subattribute in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-secondary-store-adapter-prop

Show Secondary Store Adapter properties

get-secondary-store-adapter-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Secondary Store Adapter in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-server-group-prop

Show Server Group properties

get-server-group-prop Arguments

--group-name {name}

Description The name of the Server Group

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Server Group in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-server-instance-listener-prop

Show Server Instance Listener properties

get-server-instance-listener-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--listener-name {name}

Description The name of the Server Instance Listener

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Server Instance Listener or one of its subcomponents HTTP Server Instance Listener, LDAP Server Instance Listener in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-server-instance-prop

Show Server Instance properties

get-server-instance-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

get-sideband-api-endpoint-prop

Show Sideband API Endpoint properties

get-sideband-api-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Sideband API Endpoint

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-sideband-api-shared-secret-prop

Show Sideband API Shared Secret properties

get-sideband-api-shared-secret-prop Arguments

--secret-name {name}

Description The name of the Sideband API Shared Secret

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sideband API Shared Secret in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-store-adapter-mapping-prop

Show Store Adapter Mapping properties

get-store-adapter-mapping-prop Arguments

--type-name {name}

Description The name of the Mapping SCIM Resource Type

Required No

Multi-Valued No

--mapping-name {name}

Description The name of the Store Adapter Mapping

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Store Adapter Mapping in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-store-adapter-plugin-prop

Show Store Adapter Plugin properties

get-store-adapter-plugin-prop Arguments

--plugin-name {name}

Description The name of the Store Adapter Plugin

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Store Adapter Plugin or one of its subcomponents Third Party Store Adapter Plugin in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-store-adapter-prop

Show Store Adapter properties

get-store-adapter-prop Arguments

--adapter-name {name}

Description The name of the Store Adapter

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Store Adapter or one of its subcomponents LDAP Store Adapter, Third Party Store Adapter in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-token-claim-validation-prop

Show Token Claim Validation properties

get-token-claim-validation-prop Arguments

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

See 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

get-token-resource-lookup-method-prop

Show Token Resource Lookup Method properties

get-token-resource-lookup-method-prop Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

--method-name {name}

Description The name of the Token Resource Lookup Method

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Token Resource Lookup Method or one of its subcomponents SCIM Token Resource Lookup Method, Third Party Token Resource Lookup Method in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-topology-admin-user-prop

Show Topology Admin User properties

get-topology-admin-user-prop Arguments

--user-name {name}

Description The name of the Topology Admin User

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-trust-manager-provider-prop

Show Trust Manager Provider properties

get-trust-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Trust Manager Provider

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Trust Manager Provider or one of its subcomponents Blind Trust Manager Provider, File Based Trust Manager Provider, JVM Default Trust Manager Provider, Third Party Trust Manager Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-trusted-certificate-prop

Show Trusted Certificate properties

get-trusted-certificate-prop Arguments

--certificate-name {name}

Description The name of the Trusted Certificate

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Trusted Certificate in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-vault-authentication-method-prop

Show Vault Authentication Method properties

get-vault-authentication-method-prop Arguments

--method-name {name}

Description The name of the Vault Authentication Method

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Vault Authentication Method or one of its subcomponents App Role Vault Authentication Method, Static Token Vault Authentication Method, User Pass Vault Authentication Method in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-velocity-context-provider-prop

Show Velocity Context Provider properties

get-velocity-context-provider-prop Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--provider-name {name}

Description The name of the Velocity Context Provider

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Velocity Context Provider or one of its subcomponents Third Party Velocity Context Provider, Velocity Tools Velocity Context Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-velocity-template-loader-prop

Show Velocity Template Loader properties

get-velocity-template-loader-prop Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--loader-name {name}

Description The name of the Velocity Template Loader

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Velocity Template Loader in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

get-web-application-extension-prop

Show Web Application Extension properties

get-web-application-extension-prop Arguments

--extension-name {name}

Description The name of the Web Application Extension

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Web Application Extension or one of its subcomponents Console Web Application Extension in the Server Configuration Reference.

Required No

Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

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

list-access-token-validators

List existing Access Token Validators

list-access-token-validators Arguments

--property {property}

Description The name of a property to be displayed.

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

List existing Advice

list-advice Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Advice or one of its subcomponents Add Filter Advice, Combine SCIM Search Authorizations Advice, Denied Reason Advice, Exclude Attributes Advice, Filter Response Advice, Include Attributes Advice, Modify Attributes Advice, Modify Headers Advice, Modify Query Advice, Modify SCIM Patch Advice, Regex Replace Attributes Advice, Third Party Advice in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-alert-handlers

List existing Alert Handlers

list-alert-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Alert Handler or one of its subcomponents Error Log Alert Handler, Exec Alert Handler, Scripted Alert Handler, JMX Alert Handler, 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-authorization-policy-decision-shared-secrets

List existing Authorization Policy Decision Shared Secrets

list-authorization-policy-decision-shared-secrets Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Authorization Policy Decision Shared Secret in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-azure-authentication-methods

List existing Azure Authentication Methods

list-azure-authentication-methods Arguments

--property {property}

Description The name of a property to be displayed.

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

List existing Backends

list-backends Arguments

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

list-certificate-mappers

List existing Certificate Mappers

list-certificate-mappers Arguments

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

list-cipher-secret-keys

List existing Cipher Secret Keys

list-cipher-secret-keys Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

list-cipher-stream-providers

List existing Cipher Stream Providers

list-cipher-stream-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, 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-conjur-authentication-methods

List existing Conjur Authentication Methods

list-conjur-authentication-methods Arguments

--property {property}

Description The name of a property to be displayed.

See 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-connection-handlers

List existing Connection Handlers

list-connection-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Connection Handler or one of its subcomponents HTTP Connection Handler, JMX Connection Handler, LDAP Connection Handler, LDIF Connection Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-correlation-attribute-pairs

List existing Correlation Attribute Pairs

list-correlation-attribute-pairs Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Correlation Attribute Pair in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-custom-logged-stats

List existing Custom Logged Stats

list-custom-logged-stats Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Custom Logged Stats in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-debug-targets

List existing Debug Targets

list-debug-targets Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Debug Target in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-deployment-package-stores

List existing Deployment Package Stores

list-deployment-package-stores Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Deployment Package Store or one of its subcomponents Azure Deployment Package Store, Filesystem Deployment Package Store, S3 Deployment Package Store in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-dn-maps

List existing DN Maps

list-dn-maps Arguments

--property {property}

Description The name of a property to be displayed.

See properties for DN Map in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-error-templates

List existing Error Templates

list-error-templates Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Error Template in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-external-servers

List existing External Servers

list-external-servers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for External Server or one of its subcomponents HTTP External Server, LDAP External Server, Amazon Aws External Server, Conjur External Server, JDBC External Server, Kafka Cluster External Server, Mock 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-failure-lockout-actions

List existing Failure Lockout Actions

list-failure-lockout-actions Arguments

--property {property}

Description The name of a property to be displayed.

See 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-gateway-api-endpoints

List existing Gateway API Endpoints

list-gateway-api-endpoints Arguments

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

list-gauge-data-sources

List existing Gauge Data Sources

list-gauge-data-sources Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Gauge Data Source or one of its subcomponents Indicator Gauge Data Source, Numeric Gauge Data Source in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-gauges

List existing Gauges

list-gauges Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Gauge or one of its subcomponents Indicator Gauge, Numeric Gauge in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-http-servlet-cross-origin-policies

List existing HTTP Servlet Cross Origin Policies

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

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Cross Origin Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-http-servlet-extensions

List existing HTTP Servlet Extensions

list-http-servlet-extensions Arguments

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

list-id-token-validators

List existing ID Token Validators

list-id-token-validators Arguments

--property {property}

Description The name of a property to be displayed.

See 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-identity-mappers

List existing Identity Mappers

list-identity-mappers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Identity Mapper or one of its subcomponents Aggregate 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-impacted-attributes-providers

List existing Impacted Attributes Providers

list-impacted-attributes-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Impacted Attributes Provider or one of its subcomponents SCIM Impacted Attributes Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-inter-server-authentication-info

List existing Inter Server Authentication Info

list-inter-server-authentication-info Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--listener-name {name}

Description The name of the Server Instance Listener

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Inter Server Authentication Info or one of its subcomponents Certificate Inter Server Authentication Info, Password Inter Server Authentication Info in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-key-manager-providers

List existing Key Manager Providers

list-key-manager-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, PKCS11 Key Manager Provider, Third Party Key Manager Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-key-pairs

List existing Key Pairs

list-key-pairs Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Key Pair in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-ldap-external-server-templates

List existing LDAP External Server Templates

list-ldap-external-server-templates Arguments

--property {property}

Description The name of a property to be displayed.

See properties for LDAP External Server Template in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-ldap-health-checks

List existing LDAP Health Checks

list-ldap-health-checks Arguments

--property {property}

Description The name of a property to be displayed.

See properties for LDAP Health Check or one of its subcomponents Admin Alert LDAP Health Check, Scripted LDAP Health Check, Replication Backlog LDAP Health Check, Search LDAP Health Check, Third Party LDAP Health Check, Work Queue Busyness LDAP Health Check in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-load-balancing-algorithms

List existing Load Balancing Algorithms

list-load-balancing-algorithms Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Load Balancing Algorithm or one of its subcomponents Location Based Load Balancing Algorithm, Single Server Load Balancing Algorithm, Weighted Load Balancing Algorithm in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-locations

List existing Locations

list-locations Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Location in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-log-file-rotation-listeners

List existing Log File Rotation Listeners

list-log-file-rotation-listeners Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log File Rotation Listener or one of its subcomponents Copy Log File Rotation Listener, Summarize Log File Rotation Listener, Third Party Log File Rotation Listener in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-log-publishers

List existing Log Publishers

list-log-publishers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log Publisher or one of its subcomponents Access Log Publisher, HTTP Operation Log Publisher, Error Log Publisher, Sync Log Publisher, Debug Log Publisher, Policy Decision Log Publisher, Trace Log Publisher in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-log-retention-policies

List existing Log Retention Policies

list-log-retention-policies Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log Retention Policy or one of its subcomponents File Count Log Retention Policy, Free Disk Space Log Retention Policy, Never Delete Log Retention Policy, Size Limit Log Retention Policy, Time Limit Log Retention Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-log-rotation-policies

List existing Log Rotation Policies

list-log-rotation-policies Arguments

--property {property}

Description The name of a property to be displayed.

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

Required No

Multi-Valued Yes

list-mac-secret-keys

List existing Mac Secret Keys

list-mac-secret-keys Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

list-monitor-providers

List existing Monitor Providers

list-monitor-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Entry Cache Monitor Provider, 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-monitoring-endpoints

List existing Monitoring Endpoints

list-monitoring-endpoints Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Monitoring Endpoint or one of its subcomponents StatsD Monitoring Endpoint in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-obscured-values

List existing Obscured Values

list-obscured-values Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Obscured Value in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-passphrase-providers

List existing Passphrase Providers

list-passphrase-providers Arguments

--property {property}

Description The name of a property to be displayed.

See 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-password-policies

List existing Password Policies

list-password-policies Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Password Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-password-storage-schemes

List existing Password Storage Schemes

list-password-storage-schemes Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Password Storage Scheme or one of its subcomponents AES 256 Password Storage Scheme, AES Password Storage Scheme, Amazon Secrets Manager Password Storage Scheme, Argon2 Password Storage Scheme, Azure Key Vault Password Storage Scheme, Base64 Password Storage Scheme, Bcrypt Password Storage Scheme, Blowfish Password Storage Scheme, Clear Password Storage Scheme, Conjur Password Storage Scheme, Crypt Password Storage Scheme, MD5 Password Storage Scheme, PBKDF2 Password Storage Scheme, RC4 Password Storage Scheme, SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted SHA256 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA512 Password Storage Scheme, Scrypt Password Storage Scheme, Third Party Enhanced Password Storage Scheme, Third Party Password Storage Scheme, Triple DES Password Storage Scheme, Vault Password Storage Scheme in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-plugins

List existing Plugins

list-plugins Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Plugin or one of its subcomponents Attribute Mapper Plugin, Change Subscription Notification Plugin, Changelog Password Encryption Plugin, Purge Expired Data Plugin, Composed Attribute Plugin, DN Mapper Plugin, Delay Plugin, Encrypt Attribute Values Plugin, Entry UUID Plugin, Global Referential Integrity Plugin, Globally Unique Attribute Plugin, Scripted Plugin, Internal Search Rate Plugin, LDAP Attribute Description List Plugin, LDAP Result Code Tracker Plugin, Last Access Time Plugin, Last Mod Plugin, Modifiable Password Policy State Plugin, Monitor History Plugin, Pass Through Authentication Plugin, Password Policy Import Plugin, Periodic GC Plugin, Stats Plugin, PingOne Pass Through Authentication Plugin, Pluggable Pass Through Authentication Plugin, Pre Update Config Plugin, Processing Time Histogram Plugin, Profiler Plugin, Referential Integrity Plugin, Referral On Update Plugin, SNMP Master Agent Plugin, SNMP Subagent Plugin, Search Shutdown Plugin, Secret Key Delete Alert Plugin, Seven Bit Clean Plugin, Simple To External Bind Plugin, Sub Operation Timing Plugin, Third Party Plugin, Unique Attribute Plugin in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-policy-configuration-keys

List existing Policy Configuration Keys

list-policy-configuration-keys Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Policy Configuration Key in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-properties

Describes managed objects and their properties

list-properties Arguments

-c {category}
--category {category}

Description The category of components whose properties should be described. The list of categories is available in the 'Component' column in the output of 'dsconfig list-properties'

Required No

Multi-Valued No

-t {type}
--type {type}

Description The type of components whose properties should be described. The value for TYPE must be one of the component types associated with the CATEGORY specified using the '--category' option. The list of categories is available in the 'Type' column in the output of 'dsconfig list-properties'

Required No

Multi-Valued No

--inherited

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

--complexity {level}

Description Specifies the maximum complexity level for items to display. Allowed values (in order of increasing complexity) are 'basic', 'standard', 'advanced', and 'expert'. Advanced properties will be shown when a value of 'advanced' or 'expert' is provided

Allowed Values basic
standard
advanced
expert

Default Value standard

Required No

Multi-Valued No

--includeDescription

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

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

list-recurring-task-chains

List existing Recurring Task Chains

list-recurring-task-chains Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task Chain in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-recurring-tasks

List existing Recurring Tasks

list-recurring-tasks Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task or one of its subcomponents Backup Recurring Task, 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-root-dn-users

List existing Root DN Users

list-root-dn-users Arguments

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

list-sasl-mechanism-handlers

List existing SASL Mechanism Handlers

list-sasl-mechanism-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for SASL Mechanism Handler or one of its subcomponents Anonymous SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler, External SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, 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-scim-attributes

List existing SCIM Attributes

list-scim-attributes Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Attribute in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-scim-resource-types

List existing SCIM Resource Types

list-scim-resource-types Arguments

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Resource Type or one of its subcomponents Mapping SCIM Resource Type, Pass Through SCIM Resource Type in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-scim-schemas

List existing SCIM Schemas

list-scim-schemas Arguments

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Schema in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-scim-sub-resource-type-handlers

List existing SCIM Sub Resource Type Handlers

list-scim-sub-resource-type-handlers Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Sub Resource Type Handler or one of its subcomponents Third Party SCIM Sub Resource Type Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-scim-subattributes

List existing SCIM Subattributes

list-scim-subattributes Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Subattribute in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-secondary-store-adapters

List existing Secondary Store Adapters

list-secondary-store-adapters Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Secondary Store Adapter in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-server-groups

List existing Server Groups

list-server-groups Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Server Group in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-server-instance-listeners

List existing Server Instance Listeners

list-server-instance-listeners Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Server Instance Listener or one of its subcomponents HTTP Server Instance Listener, LDAP Server Instance Listener in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-server-instances

List existing Server Instances

list-server-instances Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Server Instance or one of its subcomponents 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-sideband-api-endpoints

List existing Sideband API Endpoints

list-sideband-api-endpoints Arguments

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

list-sideband-api-shared-secrets

List existing Sideband API Shared Secrets

list-sideband-api-shared-secrets Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Sideband API Shared Secret in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-store-adapter-mappings

List existing Store Adapter Mappings

list-store-adapter-mappings Arguments

--type-name {name}

Description The name of the Mapping SCIM Resource Type

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Store Adapter Mapping in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-store-adapter-plugins

List existing Store Adapter Plugins

list-store-adapter-plugins Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Store Adapter Plugin or one of its subcomponents Third Party Store Adapter Plugin in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-store-adapters

List existing Store Adapters

list-store-adapters Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Store Adapter or one of its subcomponents LDAP Store Adapter, Third Party Store Adapter in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-token-claim-validations

List existing Token Claim Validations

list-token-claim-validations Arguments

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

See 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-token-resource-lookup-methods

List existing Token Resource Lookup Methods

list-token-resource-lookup-methods Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Token Resource Lookup Method or one of its subcomponents SCIM Token Resource Lookup Method, Third Party Token Resource Lookup Method in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-topology-admin-users

List existing Topology Admin Users

list-topology-admin-users Arguments

--property {property}

Description The name of a property to be displayed

Required No

Multi-Valued Yes

list-trust-manager-providers

List existing Trust Manager Providers

list-trust-manager-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Trust Manager Provider or one of its subcomponents Blind Trust Manager Provider, File Based Trust Manager Provider, JVM Default Trust Manager Provider, Third Party Trust Manager Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-trusted-certificates

List existing Trusted Certificates

list-trusted-certificates Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Trusted Certificate in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-vault-authentication-methods

List existing Vault Authentication Methods

list-vault-authentication-methods Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Vault Authentication Method or one of its subcomponents App Role Vault Authentication Method, Static Token Vault Authentication Method, User Pass Vault Authentication Method in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-velocity-context-providers

List existing Velocity Context Providers

list-velocity-context-providers Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Velocity Context Provider or one of its subcomponents Third Party Velocity Context Provider, Velocity Tools Velocity Context Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-velocity-template-loaders

List existing Velocity Template Loaders

list-velocity-template-loaders Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Velocity Template Loader in the Server Configuration Reference.

Required No

Multi-Valued Yes

list-web-application-extensions

List existing Web Application Extensions

list-web-application-extensions Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Web Application Extension or one of its subcomponents Console Web Application Extension in the Server Configuration Reference.

Required No

Multi-Valued Yes

set-access-control-handler-prop

Modify Access Control Handler properties

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

set-access-control-handler-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Access Control Handler or one of its subcomponents DSEE Compat Access Control Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-access-token-validator-prop

Modify Access Token Validator properties

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

set-access-token-validator-prop Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

set-advice-prop

Modify Advice 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-advice-prop Arguments

--advice-name {name}

Description The name of the Advice

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Advice or one of its subcomponents Add Filter Advice, Combine SCIM Search Authorizations Advice, Denied Reason Advice, Exclude Attributes Advice, Filter Response Advice, Include Attributes Advice, Modify Attributes Advice, Modify Headers Advice, Modify Query Advice, Modify SCIM Patch Advice, Regex Replace Attributes Advice, Third Party Advice in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-alarm-manager-prop

Modify Alarm Manager properties

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

set-alarm-manager-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Alarm Manager in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-alert-handler-prop

Modify Alert Handler properties

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

set-alert-handler-prop Arguments

--handler-name {name}

Description The name of the Alert Handler

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

set-authorization-policy-decision-shared-secret-prop

Modify Authorization Policy Decision Shared Secret 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-authorization-policy-decision-shared-secret-prop Arguments

--secret-name {name}

Description The name of the Authorization Policy Decision Shared Secret

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Authorization Policy Decision Shared Secret in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-azure-authentication-method-prop

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

set-azure-authentication-method-prop Arguments

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

See 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

set-backend-prop

Modify Backend properties

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

set-backend-prop Arguments

--backend-name {name}

Description The name of the Backend

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-certificate-mapper-prop

Modify Certificate Mapper properties

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

set-certificate-mapper-prop Arguments

--mapper-name {name}

Description The name of the Certificate Mapper

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-cipher-secret-key-prop

Modify Cipher Secret Key properties

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

set-cipher-secret-key-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--key-name {name}

Description The name of the Cipher Secret Key

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-cipher-stream-provider-prop

Modify Cipher Stream Provider properties

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

set-cipher-stream-provider-prop Arguments

--provider-name {name}

Description The name of the Cipher Stream Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, 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

set-conjur-authentication-method-prop

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

set-conjur-authentication-method-prop Arguments

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

See 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

set-connection-handler-prop

Modify Connection Handler properties

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

set-connection-handler-prop Arguments

--handler-name {name}

Description The name of the Connection Handler

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Connection Handler or one of its subcomponents HTTP Connection Handler, JMX Connection Handler, LDAP Connection Handler, LDIF Connection Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-correlation-attribute-pair-prop

Modify 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

set-correlation-attribute-pair-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

--pair-name {name}

Description The name of the 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 reset.

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

set-crypto-manager-prop

Modify Crypto Manager properties

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

set-crypto-manager-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Crypto Manager in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-custom-logged-stats-prop

Modify Custom Logged Stats properties

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

set-custom-logged-stats-prop Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin

Required No

Multi-Valued No

--stats-name {name}

Description The name of the Custom Logged Stats

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Custom Logged Stats in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-debug-target-prop

Modify Debug Target properties

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

set-debug-target-prop Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher

Required No

Multi-Valued No

--target-name {name}

Description The name of the Debug Target

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Debug Target in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-deployment-package-store-prop

Modify Deployment Package Store 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-deployment-package-store-prop Arguments

--store-name {name}

Description The name of the Deployment Package Store

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Deployment Package Store or one of its subcomponents Azure Deployment Package Store, Filesystem Deployment Package Store, S3 Deployment Package Store in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-dn-map-prop

Modify DN Map properties

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

set-dn-map-prop Arguments

--map-name {name}

Description The name of the DN Map

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for DN Map in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-error-template-prop

Modify Error Template 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-error-template-prop Arguments

--template-name {name}

Description The name of the Error Template

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Error Template in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-external-server-prop

Modify External Server properties

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

set-external-server-prop Arguments

--server-name {name}

Description The name of the External Server

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

set-failure-lockout-action-prop

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

set-failure-lockout-action-prop Arguments

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

See 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

set-gateway-api-endpoint-prop

Modify Gateway API Endpoint properties

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

set-gateway-api-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Gateway API Endpoint

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-gauge-data-source-prop

Modify Gauge Data Source properties

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

set-gauge-data-source-prop Arguments

--source-name {name}

Description The name of the Gauge Data Source

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Gauge Data Source or one of its subcomponents Indicator Gauge Data Source, Numeric Gauge Data Source in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-gauge-prop

Modify Gauge properties

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

set-gauge-prop Arguments

--gauge-name {name}

Description The name of the Gauge

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Gauge or one of its subcomponents Indicator Gauge, Numeric Gauge in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-global-configuration-prop

Modify Global Configuration properties

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

set-global-configuration-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Global Configuration in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-http-configuration-prop

Modify HTTP Configuration properties

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

set-http-configuration-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for HTTP Configuration in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-http-servlet-cross-origin-policy-prop

Modify HTTP Servlet Cross Origin Policy properties

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

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

--policy-name {name}

Description The name of the HTTP Servlet Cross Origin Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for HTTP Servlet Cross Origin Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-http-servlet-extension-prop

Modify HTTP Servlet Extension properties

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

set-http-servlet-extension-prop Arguments

--extension-name {name}

Description The name of the HTTP Servlet Extension

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-id-token-validator-prop

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

set-id-token-validator-prop Arguments

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

See 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

set-identity-mapper-prop

Modify Identity Mapper properties

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

set-identity-mapper-prop Arguments

--mapper-name {name}

Description The name of the Identity Mapper

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Identity Mapper or one of its subcomponents Aggregate 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

set-impacted-attributes-provider-prop

Modify Impacted Attributes Provider properties

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

set-impacted-attributes-provider-prop Arguments

--provider-name {name}

Description The name of the Impacted Attributes Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Impacted Attributes Provider or one of its subcomponents SCIM Impacted Attributes Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-inter-server-authentication-info-prop

Modify Inter Server Authentication Info properties

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

set-inter-server-authentication-info-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--listener-name {name}

Description The name of the Server Instance Listener

Required No

Multi-Valued No

--info-name {name}

Description The name of the Inter Server Authentication Info

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Inter Server Authentication Info or one of its subcomponents Certificate Inter Server Authentication Info, Password Inter Server Authentication Info in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-key-manager-provider-prop

Modify Key Manager Provider properties

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

set-key-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Key Manager Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, PKCS11 Key Manager Provider, Third Party Key Manager Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-key-pair-prop

Modify Key Pair properties

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

set-key-pair-prop Arguments

--pair-name {name}

Description The name of the Key Pair

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Key Pair in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-ldap-external-server-template-prop

Modify LDAP External Server Template properties

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

set-ldap-external-server-template-prop Arguments

--template-name {name}

Description The name of the LDAP External Server Template

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for LDAP External Server Template in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-ldap-health-check-prop

Modify LDAP Health Check properties

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

set-ldap-health-check-prop Arguments

--check-name {name}

Description The name of the LDAP Health Check

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for LDAP Health Check or one of its subcomponents Admin Alert LDAP Health Check, Scripted LDAP Health Check, Replication Backlog LDAP Health Check, Search LDAP Health Check, Third Party LDAP Health Check, Work Queue Busyness LDAP Health Check in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-ldap-sdk-debug-logger-prop

Modify LDAP SDK Debug Logger properties

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

set-ldap-sdk-debug-logger-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for LDAP SDK Debug Logger in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-license-prop

Modify License properties

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

set-license-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for License in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-load-balancing-algorithm-prop

Modify Load Balancing Algorithm 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-load-balancing-algorithm-prop Arguments

--algorithm-name {name}

Description The name of the Load Balancing Algorithm

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Load Balancing Algorithm or one of its subcomponents Location Based Load Balancing Algorithm, Single Server Load Balancing Algorithm, Weighted Load Balancing Algorithm in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-location-prop

Modify Location properties

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

set-location-prop Arguments

--location-name {name}

Description The name of the Location

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Location in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-log-file-rotation-listener-prop

Modify Log File Rotation Listener properties

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

set-log-file-rotation-listener-prop Arguments

--listener-name {name}

Description The name of the Log File Rotation Listener

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Log File Rotation Listener or one of its subcomponents Copy Log File Rotation Listener, Summarize Log File Rotation Listener, Third Party Log File Rotation Listener in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-log-publisher-prop

Modify Log Publisher properties

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

set-log-publisher-prop Arguments

--publisher-name {name}

Description The name of the Log Publisher

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Log Publisher or one of its subcomponents Access Log Publisher, HTTP Operation Log Publisher, Error Log Publisher, Sync Log Publisher, Debug Log Publisher, Policy Decision Log Publisher, Trace Log Publisher in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-log-retention-policy-prop

Modify Log Retention Policy properties

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

set-log-retention-policy-prop Arguments

--policy-name {name}

Description The name of the Log Retention Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Log Retention Policy or one of its subcomponents File Count Log Retention Policy, Free Disk Space Log Retention Policy, Never Delete Log Retention Policy, Size Limit Log Retention Policy, Time Limit Log Retention Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-log-rotation-policy-prop

Modify Log Rotation Policy properties

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

set-log-rotation-policy-prop Arguments

--policy-name {name}

Description The name of the Log Rotation Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-mac-secret-key-prop

Modify Mac Secret Key properties

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

set-mac-secret-key-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--key-name {name}

Description The name of the Mac Secret Key

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-monitor-provider-prop

Modify Monitor Provider properties

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

set-monitor-provider-prop Arguments

--provider-name {name}

Description The name of the Monitor Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Entry Cache Monitor Provider, 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

set-monitoring-endpoint-prop

Modify Monitoring Endpoint properties

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

set-monitoring-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Monitoring Endpoint

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Monitoring Endpoint or one of its subcomponents StatsD Monitoring Endpoint in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-obscured-value-prop

Modify Obscured Value properties

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

set-obscured-value-prop Arguments

--value-name {name}

Description The name of the Obscured Value

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Obscured Value in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-passphrase-provider-prop

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

set-passphrase-provider-prop Arguments

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

See 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

set-password-policy-prop

Modify Password Policy properties

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

set-password-policy-prop Arguments

--policy-name {name}

Description The name of the Password Policy

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Password Policy in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-password-storage-scheme-prop

Modify Password Storage Scheme properties

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

set-password-storage-scheme-prop Arguments

--scheme-name {name}

Description The name of the Password Storage Scheme

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Password Storage Scheme or one of its subcomponents AES 256 Password Storage Scheme, AES Password Storage Scheme, Amazon Secrets Manager Password Storage Scheme, Argon2 Password Storage Scheme, Azure Key Vault Password Storage Scheme, Base64 Password Storage Scheme, Bcrypt Password Storage Scheme, Blowfish Password Storage Scheme, Clear Password Storage Scheme, Conjur Password Storage Scheme, Crypt Password Storage Scheme, MD5 Password Storage Scheme, PBKDF2 Password Storage Scheme, RC4 Password Storage Scheme, SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted SHA256 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA512 Password Storage Scheme, Scrypt Password Storage Scheme, Third Party Enhanced Password Storage Scheme, Third Party Password Storage Scheme, Triple DES Password Storage Scheme, Vault Password Storage Scheme in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-plugin-prop

Modify Plugin properties

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

set-plugin-prop Arguments

--plugin-name {name}

Description The name of the Plugin

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Plugin or one of its subcomponents Attribute Mapper Plugin, Change Subscription Notification Plugin, Changelog Password Encryption Plugin, Purge Expired Data Plugin, Composed Attribute Plugin, DN Mapper Plugin, Delay Plugin, Encrypt Attribute Values Plugin, Entry UUID Plugin, Global Referential Integrity Plugin, Globally Unique Attribute Plugin, Scripted Plugin, Internal Search Rate Plugin, LDAP Attribute Description List Plugin, LDAP Result Code Tracker Plugin, Last Access Time Plugin, Last Mod Plugin, Modifiable Password Policy State Plugin, Monitor History Plugin, Pass Through Authentication Plugin, Password Policy Import Plugin, Periodic GC Plugin, Stats Plugin, PingOne Pass Through Authentication Plugin, Pluggable Pass Through Authentication Plugin, Pre Update Config Plugin, Processing Time Histogram Plugin, Profiler Plugin, Referential Integrity Plugin, Referral On Update Plugin, SNMP Master Agent Plugin, SNMP Subagent Plugin, Search Shutdown Plugin, Secret Key Delete Alert Plugin, Seven Bit Clean Plugin, Simple To External Bind Plugin, Sub Operation Timing Plugin, Third Party Plugin, Unique Attribute Plugin in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-plugin-root-prop

Modify Plugin Root properties

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

set-plugin-root-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Plugin Root in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-policy-configuration-key-prop

Modify Policy Configuration Key properties

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

set-policy-configuration-key-prop Arguments

--key-name {name}

Description The name of the Policy Configuration Key

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Policy Configuration Key in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-policy-decision-service-prop

Modify Policy Decision 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-policy-decision-service-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Policy Decision Service in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-recurring-task-chain-prop

Modify Recurring Task Chain properties

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

set-recurring-task-chain-prop Arguments

--chain-name {name}

Description The name of the Recurring Task Chain

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Recurring Task Chain in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-recurring-task-prop

Modify Recurring Task properties

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

set-recurring-task-prop Arguments

--task-name {name}

Description The name of the Recurring Task

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Recurring Task or one of its subcomponents Backup Recurring Task, 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

set-root-dn-prop

Modify Root DN properties

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

set-root-dn-prop Arguments

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Root DN in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-root-dn-user-prop

Modify Root DN User properties

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

set-root-dn-user-prop Arguments

--user-name {name}

Description The name of the Root DN User

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-sasl-mechanism-handler-prop

Modify SASL Mechanism Handler properties

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

set-sasl-mechanism-handler-prop Arguments

--handler-name {name}

Description The name of the SASL Mechanism Handler

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for SASL Mechanism Handler or one of its subcomponents Anonymous SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler, External SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, 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

set-scim-attribute-prop

Modify SCIM Attribute properties

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

set-scim-attribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for SCIM Attribute in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-scim-resource-type-prop

Modify SCIM Resource Type properties

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

set-scim-resource-type-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for SCIM Resource Type or one of its subcomponents Mapping SCIM Resource Type, Pass Through SCIM Resource Type in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-scim-schema-prop

Modify SCIM Schema properties

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

set-scim-schema-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for SCIM Schema in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-scim-sub-resource-type-handler-prop

Modify SCIM Sub Resource Type 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-scim-sub-resource-type-handler-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--handler-name {name}

Description The name of the SCIM Sub Resource Type Handler

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for SCIM Sub Resource Type Handler or one of its subcomponents Third Party SCIM Sub Resource Type Handler in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-scim-subattribute-prop

Modify SCIM Subattribute properties

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

set-scim-subattribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema

Required No

Multi-Valued No

--attribute-name {name}

Description The name of the SCIM Attribute

Required No

Multi-Valued No

--subattribute-name {name}

Description The name of the SCIM Subattribute

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for SCIM Subattribute in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-secondary-store-adapter-prop

Modify Secondary Store Adapter 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-secondary-store-adapter-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type

Required No

Multi-Valued No

--adapter-name {name}

Description The name of the Secondary Store Adapter

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Secondary Store Adapter in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-server-group-prop

Modify Server Group properties

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

set-server-group-prop Arguments

--group-name {name}

Description The name of the Server Group

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Server Group in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-server-instance-listener-prop

Modify Server Instance Listener properties

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

set-server-instance-listener-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--listener-name {name}

Description The name of the Server Instance Listener

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Server Instance Listener or one of its subcomponents HTTP Server Instance Listener, LDAP Server Instance Listener in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-server-instance-prop

Modify Server Instance properties

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

set-server-instance-prop Arguments

--instance-name {name}

Description The name of the Server Instance

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

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

set-sideband-api-endpoint-prop

Modify Sideband API Endpoint properties

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

set-sideband-api-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Sideband API Endpoint

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-sideband-api-shared-secret-prop

Modify Sideband API Shared Secret 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-sideband-api-shared-secret-prop Arguments

--secret-name {name}

Description The name of the Sideband API Shared Secret

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Sideband API Shared Secret in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-store-adapter-mapping-prop

Modify Store Adapter Mapping properties

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

set-store-adapter-mapping-prop Arguments

--type-name {name}

Description The name of the Mapping SCIM Resource Type

Required No

Multi-Valued No

--mapping-name {name}

Description The name of the Store Adapter Mapping

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Store Adapter Mapping in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-store-adapter-plugin-prop

Modify Store Adapter Plugin properties

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

set-store-adapter-plugin-prop Arguments

--plugin-name {name}

Description The name of the Store Adapter Plugin

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Store Adapter Plugin or one of its subcomponents Third Party Store Adapter Plugin in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-store-adapter-prop

Modify Store Adapter 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-store-adapter-prop Arguments

--adapter-name {name}

Description The name of the Store Adapter

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Store Adapter or one of its subcomponents LDAP Store Adapter, Third Party Store Adapter in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-token-claim-validation-prop

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

set-token-claim-validation-prop Arguments

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

See 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

set-token-resource-lookup-method-prop

Modify Token Resource Lookup Method properties

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

set-token-resource-lookup-method-prop Arguments

--validator-name {name}

Description The name of the Access Token Validator

Required No

Multi-Valued No

--method-name {name}

Description The name of the Token Resource Lookup Method

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Token Resource Lookup Method or one of its subcomponents SCIM Token Resource Lookup Method, Third Party Token Resource Lookup Method in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-topology-admin-user-prop

Modify Topology Admin User properties

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

set-topology-admin-user-prop Arguments

--user-name {name}

Description The name of the Topology Admin User

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-trust-manager-provider-prop

Modify Trust Manager Provider properties

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

set-trust-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Trust Manager Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Trust Manager Provider or one of its subcomponents Blind Trust Manager Provider, File Based Trust Manager Provider, JVM Default Trust Manager Provider, Third Party Trust Manager Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-trusted-certificate-prop

Modify Trusted Certificate properties

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

set-trusted-certificate-prop Arguments

--certificate-name {name}

Description The name of the Trusted Certificate

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Trusted Certificate in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-vault-authentication-method-prop

Modify Vault Authentication Method properties

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

set-vault-authentication-method-prop Arguments

--method-name {name}

Description The name of the Vault Authentication Method

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Vault Authentication Method or one of its subcomponents App Role Vault Authentication Method, Static Token Vault Authentication Method, User Pass Vault Authentication Method in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-velocity-context-provider-prop

Modify Velocity Context Provider properties

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

set-velocity-context-provider-prop Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--provider-name {name}

Description The name of the Velocity Context Provider

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Velocity Context Provider or one of its subcomponents Third Party Velocity Context Provider, Velocity Tools Velocity Context Provider in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-velocity-template-loader-prop

Modify Velocity Template Loader properties

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

set-velocity-template-loader-prop Arguments

--extension-name {name}

Description The name of the Velocity HTTP Servlet Extension

Required No

Multi-Valued No

--loader-name {name}

Description The name of the Velocity Template Loader

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Velocity Template Loader in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

set-web-application-extension-prop

Modify Web Application Extension properties

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

set-web-application-extension-prop Arguments

--extension-name {name}

Description The name of the Web Application Extension

Required No

Multi-Valued No

--set {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--reset {property}

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

See properties for Web Application Extension or one of its subcomponents Console Web Application Extension in the Server Configuration Reference.

Required No

Multi-Valued Yes

--add {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

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

Required No

Multi-Valued Yes

Arguments

-V
--version

Description Display PingAuthorize Server version information

-H
--help

Description Display general usage information

--help-ldap

Description Display help for using LDAP options

--help-sasl

Description Display help for using SASL options

--help-debug

Description Display help for using debug options

Advanced Yes

--advanced

Description Allow the configuration of advanced components and properties

-v
--verbose

Description Use verbose mode

-Q
--quiet

Description Use quiet mode

-n
--no-prompt

Description Use non-interactive mode. If data in the command is missing, you will not be prompted and the tool will fail

-F {batchFilePath}
--batch-file {batchFilePath}

Description Path to a file containing a sequence of dsconfig commands to run

Required No

Multi-Valued No

--batch-continue-on-error

Description Force the execution of all commands in the batch file on the server even if prevalidation fails. Execution will also continue even if one of the commands fails. Please note that commands affecting multiple servers can still fail to execute unless the --applyChangeTo argument is provided with the value server-group-force. Only applies if the batch file argument is also supplied

--dry-run

Description Validate configuration changes but do not apply them. This option can only be used along with the -F/--batch-file option

--applyChangeTo [server-group|server-group-force|single-server]

Description Controls whether changes apply to a single server or all servers in the configuration server group

Allowed Values single-server
server-group-force
server-group

Required No

Multi-Valued No

--offline

Description Interact with the local configuration while the server is offline. Not for use while the server is running

-r {reason}
--reason {reason}

Description A string describing the reason for the configuration change

Required No

Multi-Valued No

-Z
--useSSL

Description Use SSL for secure communication with the server

-q
--useStartTLS

Description Use StartTLS to secure communication with the server

--useNoSecurity

Description Use no security when communicating with the server

-h {host}
--hostname {host}

Description PingAuthorize Server hostname or IP address

Default Value localhost

Required No

Multi-Valued No

-p {port}
--port {port}

Description PingAuthorize 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/PingAuthorize/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-authorization-and-policies

Description Display subcommands relating to authorization and policies

--help-classifications

Description Display subcommands relating to connection and operation classification

--help-core-server

Description Display subcommands relating to core

--help-data-sources

Description Display subcommands relating to data sources

--help-database

Description Display subcommands relating to backends, indexing, and caching

--help-ldap-admin

Description Display subcommands relating to ldap (administration and monitoring)

--help-logging

Description Display subcommands relating to logging, monitoring, and notifications

--help-scim

Description Display subcommands relating to scim

--help-security

Description Display subcommands relating to security and authorization

--help-system

Description Display subcommands relating to system

--help-topology

Description Display subcommands relating to topology

--help-web

Description Display subcommands relating to web services and applications

--help-subcommands

Description Display all subcommands

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

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

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

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

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

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

Description	The name of the new Authorization Policy Decision Shared Secret
Required	No
Multi-Valued	No

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

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

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

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

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

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

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

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

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

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

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

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

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

Description	The name of the Secondary Store Adapter
Required	No
Multi-Valued	No

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

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

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

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

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

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

Description	The name of the new Deployment Package Store
Required	No
Multi-Valued	No

Description	The type of Deployment Package Store to create. The type value can be one of the following: azure \| filesystem \| s3
Required	No
Multi-Valued	No

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