WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› ›

cat.tasks

edit

cat.tasks

edit

client.cat.tasks({
  format: string,
  node_id: string | string[],
  actions: string | string[],
  detailed: boolean,
  parent_node: string,
  parent_task: number,
  h: string | string[],
  help: boolean,
  s: string | string[],
  v: boolean
})

Reference

`format`	`string` - a short version of the Accept header, e.g. json, yaml
`node_id` or `nodeId`	`string \| string[]` - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you’re connecting to, leave empty to get information from all nodes
`actions`	`string \| string[]` - A comma-separated list of actions that should be returned. Leave empty to return all.
`detailed`	`boolean` - Return detailed task information (default: false)
`parent_node` or `parentNode`	`string` - Return tasks with specified parent node.
`parent_task` or `parentTask`	`number` - Return tasks with specified parent task id. Set to -1 to return all.
`h`	`string \| string[]` - Comma-separated list of column names to display
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`v`	`boolean` - Verbose mode. Display column headers

« cat.snapshots cat.templates »