vhsm plugin register

Learn to add a plugin to vHSM's plugin catalog.

The plugin register command adds a new plugin to vHSM's plugin catalog. Registration is a prerequisite before the plugin can be used in mounts for auth methods, secrets engines, or database plugins.

You must specify the plugin type such asauth, database, or secretand provide a SHA256 checksum of the plugin binary to ensure integrity.

Usage

vhsm plugin register [options] <plugin-type> <plugin-name>

• <plugin-type>: The type of plugin (e.g., auth, database, or secret).

• <plugin-name>: The name to register the plugin under in the catalog.

Available Flags

Flag	Description
-sha256=<string>	(Required) SHA256 checksum of the plugin binary.
-command=<string>	Optional custom command for executing the plugin binary.
-args=<string>	Optional arguments to pass to the plugin binary on execution.
-version=<string>	Optional semantic version to associate with the plugin.
-builtin	Register the plugin as a built-in plugin.
-runtime=<string>	Optional runtime to use (e.g., OCI image runtime).
-oci-image=<string>	OCI image reference for plugins that use container runtimes.

Note: -sha256 is always required, even if other flags are not used.

Examples

Register a new secret plugin

vhsm plugin register \
  -sha256=d3f0a8be02f6c074cf38c9c99d4d04c9c6466249 \
  secret my-custom-plugin

Output

Success! Registered plugin: my-custom-plugin