Files
nomad/website/content/docs/configuration/plugin.mdx
Ashlee M Boyer 3444ece549 docs: Migrate link formats (#15779)
* Adding check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* chore: updates link checker workflow hash

* Migrating links to new format

Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 09:31:14 -08:00

37 lines
920 B
Plaintext

---
layout: docs
page_title: plugin Stanza - Agent Configuration
description: The "plugin" stanza is used to configure a Nomad plugin.
---
# `plugin` Stanza
<Placement groups={['plugin']} />
The `plugin` stanza is used to configure plugins.
```hcl
plugin "example-plugin" {
args = ["-my-flag"]
config {
foo = "bar"
bam {
baz = 1
}
}
}
```
The name of the plugin is the plugin's executable name relative to to the
[plugin_dir](/nomad/docs/configuration#plugin_dir). If the plugin has a
suffix, such as `.exe`, this should be omitted.
## `plugin` Parameters
- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
plugin binary when it is executed.
- `config` `(hcl/json: nil)` - Specifies configuration values for the plugin
either as HCL or JSON. The accepted values are plugin specific. Please refer
to the individual plugin's documentation.