--- name: secrets-manager-secrets-manager-management-cli-vault-dedicated title: Secrets Manager instance management CLI description: You can use the IBM Cloud® Secrets Manager instance management command-line interface (CLI) to manage your Secrets Manager Vault Dedicated instance from the command line. last-updated: 2026-09-01 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/secrets-manager?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. {:codeblock: .codeblock} {:screen: .screen} {:download: .download} {:external: target="_blank" .external} {:faq: data-hd-content-type='faq'} {:gif: data-image-type='gif'} {:important: .important} {:note: .note} {:pre: .pre} {:tip: .tip} {:preview: .preview} {:deprecated: .deprecated} {:beta: .beta} {:term: .term} {:shortdesc: .shortdesc} {:script: data-hd-video='script'} {:support: data-reuse='support'} {:table: .aria-labeledby="caption"} {:troubleshoot: data-hd-content-type='troubleshoot'} {:help: data-hd-content-type='help'} {:tsCauses: .tsCauses} {:tsResolve: .tsResolve} {:tsSymptoms: .tsSymptoms} {:video: .video} {:step: data-tutorial-type='step'} {:tutorial: data-hd-content-type='tutorial'} {:api: .ph data-hd-interface='api'} {:cli: .ph data-hd-interface='cli'} {:ui: .ph data-hd-interface='ui'} {:terraform: .ph data-hd-interface="terraform"} {:curl: .ph data-hd-programlang='curl'} {:java: .ph data-hd-programlang='java'} {:ruby: .ph data-hd-programlang='ruby'} {:c#: .ph data-hd-programlang='c#'} {:objectc: .ph data-hd-programlang='Objective C'} {:python: .ph data-hd-programlang='python'} {:javascript: .ph data-hd-programlang='javascript'} {:php: .ph data-hd-programlang='PHP'} {:swift: .ph data-hd-programlang='swift'} {:curl: .ph data-hd-programlang='curl'} {:dotnet-standard: .ph data-hd-programlang='dotnet-standard'} {:go: .ph data-hd-programlang='go'} {:unity: .ph data-hd-programlang='unity'} {:release-note: data-hd-content-type='release-note'} # Secrets Manager instance management CLI {: #secrets-manager-management-cli} You can use the IBM Cloud® Secrets Manager instance management command-line interface (CLI) to manage your Secrets Manager Vault Dedicated instance from the command line. {: shortdesc} Current version: **`2.0.7`** The Vault Dedicated plan is currently available as a public beta. Beta features are provided for evaluation and testing purposes and have limitations compared to generally available features. {: beta} ## Before you begin {: #secrets-manager-management-cli-prereq} Before you get started, install the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started&format=markdown), and then install the Secrets Manager instance management CLI plug-in by running the following command: ```sh ibmcloud plugin install secrets-manager-instance-management ``` {: pre} You're notified on the command line when updates to the IBM Cloud CLI and plug-ins are available. Keep your CLI up to date to use the latest commands, so that you can use the latest commands. You can view the current version of all installed plug-ins by running `ibmcloud plugin list`. {: tip} ## Targeting a Secrets Manager instance {: #target-sm-management-instance} To target the Secrets Manager Vault Dedicated instance, use one of the following options. * Run the `ibmcloud secrets-manager-instance-management config set` command. ```sh ibmcloud secrets-manager-instance-management config set service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com ``` {: pre} * Export an environment variable with your Secrets Manager control plane service endpoint URL. ```sh export SECRETS_MANAGER_INSTANCE_MANAGEMENT_URL=https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com ``` {: pre} * Set the service endpoint in the command. ```sh ibmcloud secrets-manager-instance-management instance --service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com ``` {: pre} Replace `{instance_ID}` and `{region}` with the values that apply to your Secrets Manager Vault Dedicated service instance. To find the endpoint URL that is specific to your instance, you can copy it from the **Endpoints** page in the Secrets Manager UI. For more information, see [Viewing your endpoint URLs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-endpoints&format=markdown#view-endpoint-urls). ## Globals {: #secrets-manager-instance-management-globals} ### Commands {: #secrets-manager-instance-management-commands} #### `ibmcloud secrets-manager-instance-management docs` {: #secrets-manager-instance-management-cli-docs-command} Opens the plug-in documentation in the web browser. ```sh ibmcloud secrets-manager-instance-management docs ``` ##### Example {: #secrets-manager-instance-management-docs-examples} ```sh ibmcloud secrets-manager-instance-management docs ``` {: pre} ### Options {: #secrets-manager-instance-management-global-options} `--region` (string) : The region where you provisioned your Vault Dedicated Instance. Available regions: us-south, eu-de. `--output` (string) : Choose an output format - can be 'json', 'yaml', or 'table'. Defaults to 'table'. `-j`, `--jmes-query` (string) : Provide a JMESPath query to customize output. `--service-url` (string) : Provide the base endpoint URL for the API. `-q`, `--quiet` : Suppresses verbose messages. `-v`, `--version` : Prints the plug-in version. #### Example {: #secrets-manager-instance-management-global-options-example} ```sh ibmcloud secrets-manager-instance-management \ --region=us-south \ --output=json \ --jmes-query="[:10]" \ --service-url="https://myservice.cloud.ibm.com" \ --quiet ``` {: pre} This example only demonstrates the global options available to all sub-commands and is not a valid command itself. {: note} ## Config {: #secrets-manager-instance-management-cli-config-command} Global parameters can also be stored in persistent configuration so that they do not need to be manually specified each time the plug-in is invoked. Each parameter can be configured with the `config` command and its subcommands. ```sh ibmcloud secrets-manager-instance-management config ``` ### `ibmcloud secrets-manager-instance-management config set` {: #secrets-manager-instance-management-cli-config-set-command} Set a new config value for a specific option. Each subcommand of the `set` command maps to a global option. Each subcommand accepts a single argument, the string representation of the value to store for the option. ```sh ibmcloud secrets-manager-instance-management config set