Reference - Actions

Playbook actions are required in each step.

Summary

Actions contains a list of built-in or plugin actions the step will run.

A step can contain as many of these actions as you need.

Each individual action in the list is a dictionary.

Required Keys

action

Each action dictionary must trigger a built-in or plugin action.

Example
1
2
3
actions:
  - ppa.ui.output_info:
      text: Hello from PPA

Validation will fail if no action is supplied

Optional Keys

save

Example
1
2
3
4
actions:
  - ppa.ui.input_text:
      text: Enter a Username
    save: username

load

Example
1
2
3
4
actions:
  - ppa.ui.output_info:
    load:
      text: username

when

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
actions:

  - ppa.ui.input_confirm:
      text: End the Task?
      confirm: Yes
      cancel: No
    save: end_task

  - exit:
    when: end_task

sequence

  • Perform the action for each item in a sequence

For Loops

See the for loops page for more information & examples.

until

  • Perform the action until a condition is met

While Loops

See the while loops page for more information & examples.