file_augeas

Manage files using Augeas - in beta.

⚙️ Compatible targets: Linux

Parameters

NameDocumentation
pathPath of the file.

This parameter is required.
scriptCommands to run on the file.

This parameter is required.
if_scriptOnly run the script if this script succeeds.

This parameter is optional.
lensLens to use (defaults to detecting the lens based on file path).

This parameter is optional.
show_contentAllow reports to contain extracts of the file content (defaults to true).

Choices:
  • true
  • false

This parameter is optional.

Outcome conditions

You need to replace ${path} with its actual canonified value.

  • ✅ Ok: file_augeas_${path}_ok
    • ☑️ Already compliant: file_augeas_${path}_kept
    • 🟨 Repaired: file_augeas_${path}_repaired
  • ❌ Error: file_augeas_${path}_error

Example

method: file_augeas
params:
  path: VALUE
  lens: OPTIONAL_VALUE
  show_content: 'true'
  script: VALUE
  if_script: OPTIONAL_VALUE

Documentation

Coming soon.