Skip to main content

security key-manager keystore delete

Contributors
Suggest changes
PDFs

Remove a disabled key manager keystore configuration.

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

This command is used to delete keystore configurations. Only keystore configurations that are not enabled can be deleted. Use the security key-manager keystore show -enable false command to see a list of all the keystore configurations that are not enabled.

Parameters

-vserver <Vserver Name> - Vserver

If you specify this parameter, then the command deletes only the keystore configurations with the given Vserver.

-keystore-type <Key Store Type> - Keystore Type

If you specify this parameter, then the command deletes only the keystore configurations with the given keystore type. This command only deletes keystore configurations with a keystore type of Azure Key Vault (AKV).

-config-name <text> - Configuration Name

If you specify this parameter, then the command deletes only the keystore configurations with the given configuration name.

Examples

The following example deletes all keystore configurations with the name "NewConfig" that are not enabled.

Cluster-1::*> security key-manager keystore delete -vserver * -keystore-type * -config-name NewConfig
1 entry was deleted.

Cluster-1::*>

The following example deletes the keystore configuration on Vserver vs0 with a keystore type AKV and "NewConfig" configuration name.

Cluster-1::*> security key-manager keystore delete -vserver vs0 -keystore-type AKV -config-name NewConfig
1 entry was deleted.

Cluster-1::*>

The following example attempts and fails to delete an enabled keystore configuration.

Cluster-1::*> security key-manager keystore delete -vserver vs0 -keystore-type AKV -config-name default

Error: command failed: The keystore configuration with name "default" and
       keystore type "AKV" is currently enabled for Vserver "vs0" and cannot be
       deleted.

Cluster-1::*>