Expand description
Manages running a shell command for the peace framework.
This item is designed to take in separate shell commands for each of the following:
- Current state logic, whose stdout defines the current state (
String
). - Goal state logic, whose stdout defines the goal state (
String
). - State diff logic, whose stdout defines the state difference.
- Ensure check, whose stdout defines if ensure execution needs to run –
true
means execution is required,false
means execution is required. - Ensure execution, whose stdout defines state physical.
- Clean check, whose exit status defines if clean execution needs to run –
true
means execution is required,false
means execution is required. - Clean execution.
Structs§
- ShCmd
- Shell command to execute.
- ShCmd
Apply Fns - ApplyFns for the command to execute.
- ShCmd
Data - Data used to run a shell command.
- ShCmd
Item - Item for executing a shell command.
- ShCmd
Params - Grouping of commands to run a shell command idempotently.
- ShCmd
Params Field Wise - Specification of how to look up values for an item’s parameters.
- ShCmd
Params Partial - Item parameters that may not necessarily have values.
- ShCmd
State - Newtype wrapper for
State<ShCmdStatePhysical<Id>, ShCmdExecutionRecord>
. - ShCmd
State Diff - Diff between the current and goal file extraction.
- ShCmd
State Diff Fn - Runs a shell command to obtain the
ShCmd
diff.
Enums§
- CmdVariant
- Command variants which take in scripts in
ShCmdParams
. - ShCmd
Error - Error while managing command execution.
- ShCmd
Execution Record - Record of a shell command execution.
- ShCmd
State Logical - State of the shell command execution.