nomad/website/source/docs/job-specification/dispatch_payload.html.md

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
docs	dispatch_payload Stanza - Job Specification	docs-job-specification-dispatch-payload	The "dispatch_payload" stanza allows a task to access dispatch payloads. to

dispatch_payload Stanza

Placement	job -> group -> task -> **dispatch_payload**

The dispatch_payload stanza is used in conjuction with a paramterized job that expects a payload. When the job is dispatched with a payload, the payload will be made available to any task that has a dispatch_payload stanza. The payload will be written to the configured file before the task is started. This allows the task to use the payload as input or configuration.

job "docs" {
  group "example" {
    task "server" {
      dispatch_payload {
        file = "config.json"
      }
    }
  }
}

dispatch_payload Parameters

• file (string: "") - Specifies the file name to write the content of dispatch payload to. The file is written relative to the task's local directory.

dispatch_payload Examples

The following examples only show the dispatch_payload stanzas. Remember that the dispatch_payload stanza is only valid in the placements listed above.

Write Payload to a File

This example shows a dispatch_payload block in a parameterized job that writes the payload to a config.json file.

dispatch_payload {
  file = "config.json"
}