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
  • Examples
  • Usage
  • Command Options

Was this helpful?

  1. vHSM CLI
  2. Configuration and Management

vhsm namespace

Learn to manage the namespaces in vHSM server

The namespace command groups subcommands for managing namespaces in vHSM.

Examples

Action
Command

List all namespaces

vhsm namespace list

List all namespaces with details

vhsm namespace list -detailed

Create a namespace (ns1/) with no custom metadata

vhsm namespace create ns1/

Create a namespace with custom metadata

vhsm namespace create -custom-metadata=foo=abc -custom-metadata=bar=123 ns1/

Patch a namespace (ns1/) to add/remove metadata

vhsm namespace patch -custom-metadata=bar=123 -remove-custom-metadata=foo ns1/

Delete a namespace (ns1/)

vhsm namespace delete ns1/

Lookup information of a namespace (ns1/)

vhsm namespace lookup ns1/

Lock the API for the current namespace

vhsm namespace lock

Lock the API for a descendant namespace (ns1/)

vhsm namespace lock ns1/

Unlock the API for the current namespace

vhsm namespace unlock -unlock-key <unlock key>

Unlock the API for a descendant namespace (ns1/)

vhsm namespace unlock -unlock-key <unlock key> ns1/


Usage

vhsm namespace <subcommand> [options] [args]

The command operates within the namespace context of the currently logged-in token.

Subcommands

Subcommand
Description

create

Create a new namespace

delete

Delete an existing namespace

list

List child namespaces

lookup

Retrieve namespace details

lock

Lock the API for a namespace

unlock

Unlock the API for a namespace


Command Options

Option
Description
Default

-detailed

Show additional namespace details when listing

false

-custom-metadata=<K=V>

Set custom metadata when creating/patching

None

-remove-custom-metadata=<key>

Remove a metadata key when patching

None

-unlock-key=<key>

Required to unlock a locked namespace

None

Previousvhsm plugin reload-statusNextvhsm operator

Last updated 2 months ago

Was this helpful?