dsconfig delete-key-manager-provider — Deletes Key Manager Providers
dsconfig delete-key-manager-provider
{options}
The dsconfig delete-key-manager-provider command takes the following options:
--provider-name {name}
The name of the Key Manager Provider.
Key Manager Provider properties depend on the Key Manager Provider type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Key Manager Provider types:
Default {name}: File Based Key Manager Provider
Enabled by default: true
See the section called “File Based Key Manager Provider” for the properties of this Key Manager Provider type.
Default {name}: LDAP Key Manager Provider
Enabled by default: true
See the section called “LDAP Key Manager Provider” for the properties of this Key Manager Provider type.
Default {name}: PKCS11 Key Manager Provider
Enabled by default: true
See the section called “PKCS11 Key Manager Provider” for the properties of this Key Manager Provider type.
-f | --force
Ignore non-existent Key Manager Providers.
Key Manager Provider properties depend on the Key Manager Provider type, which depends on the null you provide.
By default, OpenDJ directory server supports the following Key Manager Provider types:
Default null: File Based Key Manager Provider
Enabled by default: true
See the section called “File Based Key Manager Provider” for the properties of this Key Manager Provider type.
Default null: LDAP Key Manager Provider
Enabled by default: true
See the section called “LDAP Key Manager Provider” for the properties of this Key Manager Provider type.
Default null: PKCS11 Key Manager Provider
Enabled by default: true
See the section called “PKCS11 Key Manager Provider” for the properties of this Key Manager Provider type.
Key Manager Providers of type file-based-key-manager-provider have the following properties:
Indicates whether the Key Manager Provider is enabled for use.
None
true
false
No
Yes
None
No
No
The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation.
org.opends.server.extensions.FileBasedKeyManagerProvider
A Java class that implements or extends the class(es): org.opends.server.api.KeyManagerProvider
No
Yes
The Key Manager Provider must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root. Changes to this property will take effect the next time that the key manager is accessed.
None
A path to an existing file that is readable by the server.
No
Yes
None
No
No
Specifies the clear-text PIN needed to access the File Based Key Manager Provider .
None
A String
No
No
None
Changes to this property will take effect the next time that the File Based Key Manager Provider is accessed.
No
No
Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider .
None
The name of a defined environment variable that contains the clear-text PIN required to access the contents of the key store.
No
No
None
Changes to this property will take effect the next time that the File Based Key Manager Provider is accessed.
No
No
Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the File Based Key Manager Provider .
None
A path to an existing file that is readable by the server.
No
No
None
Changes to this property will take effect the next time that the File Based Key Manager Provider is accessed.
No
No
Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider .
None
The name of a defined Java property.
No
No
None
Changes to this property will take effect the next time that the File Based Key Manager Provider is accessed.
No
No
Specifies the format for the data in the key store file. Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well. If no value is provided, the JVM-default value is used. Changes to this configuration attribute will take effect the next time that the key manager is accessed.
None
Any key store format supported by the Java runtime environment.
No
No
None
No
No
Key Manager Providers of type ldap-key-manager-provider have the following properties:
The base DN beneath which LDAP key store entries are located.
None
A valid DN.
No
Yes
None
No
No
Indicates whether the Key Manager Provider is enabled for use.
None
true
false
No
Yes
None
No
No
The fully-qualified name of the Java class that provides the LDAP Key Manager Provider implementation.
org.opends.server.extensions.LDAPKeyManagerProvider
A Java class that implements or extends the class(es): org.opends.server.api.KeyManagerProvider
No
Yes
The Key Manager Provider must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the clear-text PIN needed to access the LDAP Key Manager Provider .
None
A String
No
No
None
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
No
No
Specifies the name of the environment variable that contains the clear-text PIN needed to access the LDAP Key Manager Provider .
None
The name of a defined environment variable that contains the clear-text PIN required to access the contents of the key store.
No
No
None
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
No
No
Specifies 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 .
None
A path to an existing file that is readable by the server.
No
No
None
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
No
No
Specifies the name of the Java property that contains the clear-text PIN needed to access the LDAP Key Manager Provider .
None
The name of a defined Java property.
No
No
None
Changes to this property will take effect the next time that the LDAP Key Manager Provider is accessed.
No
No
Key Manager Providers of type pkcs11-key-manager-provider have the following properties:
Indicates whether the Key Manager Provider is enabled for use.
None
true
false
No
Yes
None
No
No
The fully-qualified name of the Java class that provides the PKCS11 Key Manager Provider implementation.
org.opends.server.extensions.PKCS11KeyManagerProvider
A Java class that implements or extends the class(es): org.opends.server.api.KeyManagerProvider
No
Yes
The Key Manager Provider must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the clear-text PIN needed to access the PKCS11 Key Manager Provider .
None
A String
No
No
None
Changes to this property will take effect the next time that the PKCS11 Key Manager Provider is accessed.
No
No
Specifies the name of the environment variable that contains the clear-text PIN needed to access the PKCS11 Key Manager Provider .
None
The name of a defined environment variable that contains the clear-text PIN required to access the contents of the key store.
No
No
None
Changes to this property will take effect the next time that the PKCS11 Key Manager Provider is accessed.
No
No
Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the PKCS11 Key Manager Provider .
None
A path to an existing file that is readable by the server.
No
No
None
Changes to this property will take effect the next time that the PKCS11 Key Manager Provider is accessed.
No
No
Specifies the name of the Java property that contains the clear-text PIN needed to access the PKCS11 Key Manager Provider .
None
The name of a defined Java property.
No
No
None
Changes to this property will take effect the next time that the PKCS11 Key Manager Provider is accessed.
No
No