service_status

This generic method defines if service should run or be stopped.

⚙️ Compatible targets: Windows

Parameters

NameDocumentation
nameService name.

This parameter is required.
statusDesired state for the user - can be 'Stopped' or 'Running'.

Choices:
  • Stopped
  • Running

This parameter is required.

Outcome conditions

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

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

Example

method: service_status
params:
  name: VALUE
  status: Stopped