LDAP Key Manager Provider

The LDAP key manager provider uses an LDAP key store managed by the server to obtain server certificates.

Parent

The LDAP Key Manager Provider object inherits from Key Manager Provider.

Properties

Use the --advanced option to access advanced properties.

Basic Properties

base-dn

SynopsisThe base DN beneath which LDAP key store entries are located.
Default ValueNone
Allowed ValuesA valid DN.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

enabled

SynopsisIndicates whether the Key Manager Provider is enabled for use.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

key-store-pin

SynopsisSpecifies the clear-text PIN needed to access the LDAP Key Manager Provider .
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
AdvancedNo
Read-OnlyNo

key-store-pin-environment-variable

SynopsisSpecifies the name of the environment variable that contains the clear-text PIN needed to access the LDAP Key Manager Provider .
Default ValueNone
Allowed ValuesThe name of a defined environment variable that contains the clear-text PIN required to access the contents of the key store.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
AdvancedNo
Read-OnlyNo

key-store-pin-file

SynopsisSpecifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the LDAP Key Manager Provider .
Default ValueNone
Allowed ValuesA path to an existing file that is readable by the server.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
AdvancedNo
Read-OnlyNo

key-store-pin-property

SynopsisSpecifies the name of the Java property that contains the clear-text PIN needed to access the LDAP Key Manager Provider .
Default ValueNone
Allowed ValuesThe name of a defined Java property.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
AdvancedNo
Read-OnlyNo

Advanced Properties

java-class

SynopsisThe fully-qualified name of the Java class that provides the LDAP Key Manager Provider implementation.
Default Valueorg.opends.server.extensions.LDAPKeyManagerProvider
Allowed ValuesA Java class that extends or implements:
org.opends.server.api.KeyManagerProvider
Multi-valuedNo
RequiredYes
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedYes
Read-OnlyNo