mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
102 lines
2.7 KiB
Plaintext
102 lines
2.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: namespace - Command
|
|
description: The "namespace" command groups subcommands for interacting with namespaces.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# namespace
|
|
|
|
The `namespace` command groups subcommands for interacting with namespaces.
|
|
|
|
## Examples
|
|
|
|
List all namespaces:
|
|
|
|
```shell-session
|
|
$ vault namespace list
|
|
```
|
|
|
|
List all namespaces with additional details such as namespace ID and custom metadata:
|
|
|
|
```shell-session
|
|
$ vault namespace list -detailed
|
|
```
|
|
|
|
Create a namespace at the path `ns1/` with no custom metadata:
|
|
|
|
```shell-session
|
|
$ vault namespace create ns1/
|
|
```
|
|
|
|
Create a namespace at the path `ns1/` with multiple custom metadata keys:
|
|
|
|
```shell-session
|
|
$ vault namespace create -custom-metadata=foo=abc -custom-metadata=bar=123 ns1/
|
|
```
|
|
|
|
Patch an existing namespace at the path `ns1/` to add custom metadata key `bar` and remove key `foo`
|
|
|
|
```shell-session
|
|
$ vault namespace patch -custom-metadata=bar=123 -remove-custom-metadata=foo ns1/
|
|
```
|
|
|
|
Delete the namespace at path `ns1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace delete ns1/
|
|
```
|
|
|
|
Lookup the namespace information at path `ns1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace lookup ns1/
|
|
```
|
|
|
|
Lock the API for the current namespace:
|
|
|
|
```shell-session
|
|
$ vault namespace lock
|
|
```
|
|
|
|
Lock the API for a descendant namespace at path `current/namespace/ns1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace lock ns1/
|
|
```
|
|
|
|
Unlock the API for the current namespace:
|
|
|
|
```shell-session
|
|
$ vault namespace unlock -unlock-key <unlock key>
|
|
```
|
|
|
|
Unlock the API for a descendant namespace at path `current/namespacens1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace unlock -unlock-key <unlock key> ns1/
|
|
```
|
|
|
|
## Usage
|
|
|
|
```text
|
|
Usage: vault namespace <subcommand> [options] [args]
|
|
|
|
This command groups subcommands for interacting with Vault namespaces.
|
|
These set of subcommands operate on the context of the namespace that the
|
|
current logged in token belongs to.
|
|
|
|
Subcommands:
|
|
create Create a new namespace
|
|
delete Delete an existing namespace
|
|
list List child namespaces
|
|
lookup Look up an existing namespace
|
|
lock Lock the API for a namespace
|
|
unlock Unlock the API for a namespace
|
|
```
|
|
|
|
For more information, examples, and usage about a subcommand, click on the name
|
|
of the subcommand in the sidebar.
|