open-nomad/website/content/docs/commands/node/index.mdx
Michael Schurter 79c521e570
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

35 lines
1.1 KiB
Plaintext

---
layout: docs
page_title: 'Commands: node'
description: |
The node command is used to interact with nodes.
---
# Command: node
The `node` command is used to interact with nodes.
## Usage
Usage: `nomad node <subcommand> [options]`
Run `nomad node <subcommand> -h` for help on that subcommand. The following
subcommands are available:
- [`node config`][config] - View or modify client configuration details
- [`node drain`][drain] - Set drain mode on a given node
- [`node eligibility`][eligibility] - Toggle scheduling eligibility on a given
node
- [`node meta`][meta] - Interact with node metadata
- [`node status`][status] - Display status information about nodes
[config]: /nomad/docs/commands/node/config 'View or modify client configuration details'
[drain]: /nomad/docs/commands/node/drain 'Set drain mode on a given node'
[eligibility]: /nomad/docs/commands/node/eligibility 'Toggle scheduling eligibility on a given node'
[meta]: /nomad/docs/commands/node/meta 'Interact with node metadata'
[status]: /nomad/docs/commands/node/status 'Display status information about nodes'