Directory Server Documentation Index
Configuration Reference Home

Key Manager Provider

Note: this is an abstract component that cannot be instantiated.

Key Manager Providers are responsible for managing the key material that is used to authenticate a secure connection to its peer.

Key Manager Providers essentially provide access to the certificate that is used by the server when performing SSL or StartTLS negotiation.

↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Key Manager Providers are available in the server :

These Key Manager Providers inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to Key Manager Providers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class

Basic Properties

description

Description
A description for this Key Manager Provider
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Key Manager Provider is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

java-class (Read-Only)

Description
The fully-qualified name of the Java class that provides the Key Manager Provider implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.KeyManagerProvider
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Key Manager Providers:

dsconfig list-key-manager-providers
     [--property {propertyName}] ...

To view the configuration for an existing Key Manager Provider:

dsconfig get-key-manager-provider-prop
     --provider-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Key Manager Provider:

dsconfig set-key-manager-provider-prop
     --provider-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing Key Manager Provider:

dsconfig delete-key-manager-provider
     --provider-name {name}