Files
nomad/website/content/docs/commands/var/index.mdx
Juana De La Cuesta 72acaf6623 [17449] Introduces a locking mechanism over variables (#18207)
It includes the work over the state store, the PRC server, the HTTP server, the go API package and the CLI's  command. To read more on the actuall functionality, refer to the RFCs [NMD-178] Locking with Nomad Variables and [NMD-179] Leader election using locking mechanism for the Autoscaler.
2023-09-21 17:56:33 +02:00

67 lines
1.7 KiB
Plaintext

---
layout: docs
page_title: "Commands: var"
description: |-
The "var" command groups subcommands for interacting with Nomad variables.
---
# Command: var
The `var` command is used to interact with Nomad [variables].
## Usage
Usage: `nomad var <subcommand> [options] [args]`
Run `nomad var <subcommand> -h` for help on that subcommand. The following
subcommands are available:
- [`var init`][init] - Create a variable specification file
- [`var list`][list] - List variables the user has access to
- [`var get`][get] - Retrieve a variable
- [`var put`][put] - Insert or update a variable
- [`var purge`][purge] - Permanently delete a variable
- [`var lock`][lock] - Acquire a lock over a variable
## Examples
Create or update the variable stored at the path "secret/creds", which contains
an item named `passcode` with the value `my-long-passcode`.
```shell-session
$ nomad var put -out=table secret/creds passcode=my-long-passcode
Successfully created variable "secret/creds"!
Namespace = default
Path = secret/creds
Create Time = 2022-08-23T11:14:37-04:00
Check Index = 116
Items
passcode = my-long-passcode
```
Update a value:
```shell-session
$ nomad var get secret/creds | nomad var put -in=json -out=table -v - user=dba
Reading whole JSON variable specification from stdin
Successfully updated variable "secret/creds"!
Namespace = default
Path = secret/creds
Create Time = 2022-08-23T11:14:37-04:00
Check Index = 116
Items
passcode = my-long-passcode
user = dba
```
[variables]: /nomad/docs/concepts/variables
[init]: /nomad/docs/commands/var/init
[get]: /nomad/docs/commands/var/get
[list]: /nomad/docs/commands/var/list
[put]: /nomad/docs/commands/var/put
[purge]: /nomad/docs/commands/var/purge
[lock]: /nomad/docs/commands/var/lock