Skip to content

Actions#

Actions are the component bits that make up a plan file. They are what actually tells the client what to. Actions are YAML dictionaries that have a number of possible keys:

- action: action
  name: name_for_action
  register: variable_name
  expect: some_value
  args:
    argument1: value1
    argument2: value2

Common Attributes#

Each action has three common attributes that are shared across all actions: action, name, and invert.

Action#

The "action" attribute defines which action to run (ex. http_string). See the action index for all possible actions.

Name#

The "name" attribute is a human-readable name used for describing what the action does. A http_string action that checks to see if YetiCloud.com is responding might be named "check yeticloud.com". Action names should be unique across the entire plan file.

Invert#

The "invert" attribute inverts the actions result, causing failures to appear as successes, and vice a versa. This is useful with actions such as port to ensure that certian ports are not exposed (eg, 22 on an edge device).

Optional Attributes#

Depending on the action, it my require anywhere from zero to multiple additional arguments.

Register#

The "register" attribute is used to capture the output from an action. This is covered more in-depth in the plans section

Expect#

Expect is what the action is trying to match its output against to determine whether or not an action was successfully run. Not all actions require a value for expect.

Args#

Args is a list of argument key/value pairs supplied to the action. There are a vast number of possible arguments, and they are all documented in the action index for each action.