debug

The debug command prints messages and variables to the console. It is intended for troubleshooting playbooks and does not modify RESULT_STDOUT (builtin variables).

vars:
  $SERVER_ADDRESS: 192.42.0.254
  $NMAP: /usr/bin/nmap

commands:
  - type: debug
    cmd: "$NMAP $SERVER_ADDRESS"
    varstore: True

cmd

A message to print to the console. Supports variable substitution.

Type:

str

Default:

empty_string

Required:

False

varstore

Print out all variables currently stored in the VariableStore.

Type:

bool

Default:

False

Required:

False

exit

This setting causes the programm to exit when the command was executed. It will exit with an error in order to indicate that this is an intentional early termination.

Type:

bool

Default:

False

Required:

False

wait_for_key

Pause execution until the user presses Enter. Useful for stepping through a playbook manually.

Type:

bool

Default:

False

Required:

False