datastate.markdown

layout	title	published
default	datastate	true

[%CFEngine_function_prototype()%]

Description: Returns the current evaluation data state.

The returned data container will have the keys classes and vars.

Under classes you'll find a map with the class name as the key and true as the value. Namespaced classes will be prefixed as usual.

Under vars you'll find a map with the bundle name as the key (namespaced if necessary). Under the bundle name you'll find another map with the variable name as the key. The value is converted to a data container (JSON format) if necessary. The example should make it clearer.

Mustache templates (see [template_method][files#template_method]), if not given a template_data, will use the output of datastate() as their input.

[%CFEngine_function_attributes()%]

Example:

[%CFEngine_include_snippet(datastate.cf, #+begin_src cfengine3, .*end_src)%]

Output:

[%CFEngine_include_snippet(datastate.cf, #+begin_src\s+example_output\s*, .*end_src)%]

See also: getindices(), classesmatching(), variablesmatching(), mergedata(), [template_method][files#template_method], mustache, inline_mustache, bundlestate()

Notes:

• Beware, when assigning datastate() to a variable, multiple passes will result in recursive growth of the data structure. Consider guarding against re-definition of a variable populated by datastate().

Example illustrating how to prevent recursive growth of variable populated by datastate().

bundle agent main
{
  vars:
    "_state"
      data => datastate(),
      unless => isvariable( $(this.promiser) );
}

History:

• Introduced in CFEngine 3.6.0