Files
nomad/website/content/docs/commands/node/meta/index.mdx
Michael Schurter 38d0a2f4ef docs: add node meta command docs (#16828)
* docs: add node meta command docs

Fixes #16758

* it helps if you actually add the files to git

* fix typos and examples vs usage
2023-04-12 15:29:33 -07:00

30 lines
941 B
Plaintext

---
layout: docs
page_title: 'Commands: node meta'
description: |
The node meta commands are used to read and update node metadata.
---
# Command: node meta
The `meta` command is used to read and update node metadata. This metadata is
available for [interpolation using the `${meta.<key>}` syntax in jobs][interp].
## Usage
Usage: `nomad node meta <subcommand> [options]`
The `apply` subcommand allows for dynamically updating node metadata. The
`read` subcommand allows reading all of the metadata set on the client. All
commands interact directly with a client and allow setting a custom target with
the `-node-id` option.
Please see the individual subcommand help for detailed usage information:
- [`apply`][apply] - Modify node metadata
- [`read`][read] - Read node metadata
[interp]: /nomad/docs/runtime/interpolation#node-attributes
[apply]: /nomad/docs/commands/node/meta/apply
[read]: /nomad/docs/commands/node/meta/read