Task metadata reference
The following table shows task metadata keys, values, and default values.
Metadata key | Description | Value | Default |
---|---|---|---|
description
|
A description of what the task does. | String | None |
input_method
|
One or more input methods to use to pass parameters to the task. | environment , stdin , or powershell |
For .ps1 tasks, the default value is
powershell .For other tasks, the
default is both |
parameters
|
The parameters or input types the task accepts, which must be valid Puppet types. You can provide an optional description. Refer to Task metadata types and Adding parameters to metadata for more information. | Array of objects describing each parameter | None (equivalent to Any ) |
puppet_task_version
|
The spec version used. | Integer | 1 (which is the only valid
value) |
supports_noop
|
Whether the task supports no-op mode. Must be true for the task to accept the --noop option on the command line. |
Boolean | false
|
implementations
|
A list of task implementations and the requirements used to select which one to run. Refer to Cross-platform tasks for more information. | Array of objects describing each implementation | None |
files
|
A list of files to be provided when running the task, addressed by module. Refer to Sharing task code for more information. | Array of strings | None |