Virtual HSM
Home
  • Virtual HSM
  • Documentation
    • What is Virtual HSM?
    • Use Case: Attested Secret Provisioning in the Cloud
    • Setup
      • Install
      • vHSM Server Configuration
        • Parameters
        • vHSM Telemetry Parameters
      • vHSM Agent
        • Agent Configuration
      • vHSM Proxy
        • Proxy Configuration
    • Get Started
      • Start the Vault server
      • MariaDB root admin password provisioning on Azure DCXas_v5 VM
    • Supported Cloud Configurations
  • Tutorials
    • Deploying the vhsm Container on an EC2 Instance
    • CLI quickstart
    • vHSM Agent quickstart
    • vHSM Proxy quickstart
    • Passing vHSM secrets using ConfigMaps
    • Provisioning MariaDB Password on Azure DCXas_v5 VM
    • Registering a buckypaper plugin
    • Monitoring vHSM with Grafana
  • Integration with Utimaco SecurityServer
    • Integrate enclaive vHSM with Utimaco HSM
  • API
    • Auth
    • Default
    • Secrets
    • System
    • Identity
    • Models
  • vHSM CLI
    • Server and Infrastructure Management
      • vhsm server
      • vhsm proxy
      • vhsm monitor
      • vhsm status
      • vhsm agent
    • Secret Management
      • vhsm read
      • vhsm write
      • vhsm delete
      • vhsm list
      • vhsm secrets
        • vhsm secrets enable
        • vhsm secrets disable
        • vhsm secrets list
        • vhsm secrets move
        • vhsm secrets tune
      • vhsm unwrap
    • Configuration and Management
      • vhsm plugin
        • vhsm plugin info
        • vhsm plugin deregister
        • vhsm plugin list
        • vhsm plugin register
        • vhsm plugin reload
        • vhsm plugin reload-status
      • vhsm namespace
      • vhsm operator
      • vhsm print
      • vhsm path-help
      • vhsm lease
    • Auditing and Debugging
      • vhsm audit
      • vhsm debug
    • Attestation
    • Security and Encryption
      • vhsm pki
        • vhsm pki health-check
        • vhsm pki issue
        • vhsm pki list-intermediates
        • vhsm pki reissue
        • vhsm pki verify-sign
      • vhsm transit
      • vhsm ssh
      • vhsm transform
    • Authentication and Authorization
      • vhsm login
      • vhsm auth
      • vhsm token
      • vhsm policy
    • Storage and Data Mangement
      • vhsm kv
      • vhsm patch
    • vhsm version
      • vhsm version-history
  • Troubleshooting
    • CA Validity Period
    • CRL Validity Period
    • Root Certificate Issued Non-CA Leaves
    • Role Allows Implicit Localhost Issuance
    • Role Allows Glob-Based Wildcard Issuance
    • Performance Impact
    • Accessibility of Audit Information
    • Allow If-Modified-Since Requests
    • Auto-Tidy Disabled
    • Tidy Hasn't Run
    • Too Many Certificates
    • Enable ACME Issuance
    • ACME Response Headers Configuration
  • Resources
    • Community
    • GitHub
    • Youtube
    • CCx101 wiki
Powered by GitBook
On this page

Was this helpful?

  1. vHSM CLI
  2. Configuration and Management
  3. vhsm plugin

vhsm plugin info

Learn to fetch information about the plugin in vHSM plugin catalog.

The vhsm plugin info command displays detailed information about a plugin in vHSM’s plugin catalog. You must specify the plugin type auth, database, or secret and the plugin name.

The output includes the deprecation_status field for all built-in plugins, providing lifecycle visibility.

Usage

vhsm plugin info [options] <plugin-type> <plugin-name>
  • <plugin-type>: Type of the plugin (e.g., auth, database, or secret)

  • <plugin-name>: Name of the plugin in the catalog

Available Flags

Command options

Flag
Description

-plugin-version=<str>

Semantic version of the plugin to query. If unspecified, vHSM defaults to the unversioned or built-in plugin.

Output options

Flag
Description

-field=<string>

Display only the value of the specified field (no trailing newline). Useful for scripting.

-format=<string>

Format the output as table (default), json, or yaml. Can also be set via the VAULT_FORMATenvironment variable.


Examples

  • View versioned plugin info: vhsm plugin info auth ratls

Key                   Value
---                   -----
args                  []
builtin               true
command               n/a
deprecation_status    supported
name                  ratls
sha256                n/a
version               v1.3.7+builtin.vault
  • View info for a built-in plugin: vhsm plugin info database postgresql-database-plugin

Key                   Value
---                   -----
args                  []
builtin               true
command               n/a
deprecation_status    supported
name                  postgresql-database-plugin
sha256                n/a
version               v1.3.7+builtin.vault
  • Get only the plugin SHA256 hash: vhsm plugin info -field=sha256 auth my-custom-plugin

04ce575260fa3a2cfc477d13ac327108c50838a03917ec4d6df38ecdc64452d1
Previousvhsm pluginNextvhsm plugin deregister

Last updated 2 months ago

Was this helpful?