Puppet Plan: choria::tasks::status

Defined in:
plans/tasks/status.pp

Overview

Retrieves the status of a task from a set of nodes

Should any of the nodes not have run the task the task status retrival will fail unless fail_ok is true

Parameters:

  • task_id (String) —

    The task ID to retrieve

  • nodes (Choria::Nodes) —

    The nodes to fetch the id from

  • fail_ok (Boolean) (defaults to: false) —

    When true failure to fetch the status from some nodes will not result in a playbook failure

Returns:

  • (Choria::TaskResults) 


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'plans/tasks/status.pp', line 10

plan choria::tasks::status (
  String $task_id,
  Choria::Nodes $nodes,
  Boolean $fail_ok = false
) {
  info("Retrieving task status of task ${task_id} from ${nodes.size} nodes")

  choria::task(
    "nodes"      => $nodes,
    "action"     => "bolt_tasks.task_status",
    "silent"     => true,
    "fail_ok"    => $fail_ok,
    "properties" => {
      "task_id"  => $task_id
    }
  )
}