command_execution

Execute a command.

⚙️ Compatible targets: Linux, Windows

Parameters

Outcome conditions

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

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

Example

method: command_execution
params:
  command: VALUE

Documentation

Execute the Command in shell.

On Unix based agents, the method status will report:

• a Repaired if the return code is "0"
• an Error if the return code is not "0"

On Windows based agents the command is executed through Powershell and its & operator. The method status will report:

• an Error in Audit mode as the command will not be executed
• an Error in Enforce mode if the command did throw an exception
• an Error in Enforce mode if the LASTEXITCODE of the execution was not 0. This can happen when calling '.exe' binaries for instance.
• a Repaired in any other cases

Do not use the "exit" command on Windows as the shell used is the same than the one running the agent!

Windows examples

# A simple command execution
Write-Output "rudder test" | Out-File "C:\test.txt

# Another one with a statement, will report a Repaired if the folder exists,
# and an error if it does not.
{
  if ( (Test-Path "C:\Program Files\Rudder" -PathType Container)) {
    "Rudder folder found!"
  } else {
    throw "Rudder folder does not exist!"
  }
}