file_content

Enforce the content of a file.

⚙️ Compatible targets: Linux, Windows

Parameters

NameDocumentation
pathFile name to edit (absolute path on the target node).

This parameter is required.
linesLine(s) to add in the file - if lines is a list, please use @{lines} to pass the iterator rather than iterating over each values.

This parameter is required.
enforceEnforce the file to contain only line(s) defined (true or false).

This parameter is required.

Example

method: file_content
params:
  lines: VALUE
  enforce: VALUE
  path: VALUE

Documentation

Enforce the content of a file. The enforce parameter changes the edition method:

  • If enforce is set to true the file content will be forced
  • If enforce is set to false the file content will be forced line by line. Which means that each line managed can not be duplicated and the order will not be guaranteed.

In most cases, the enforce parameter should be set to true. When enforce is set to false, and the managed lines are:

Bob
Alice
Charly

Will be compliant with the following file contents:

Bob
Alice
Charly
Charly
Bob
Alice
Charly
Bob
Charly
Alice