Skip to content

Enum reference

Auto-generated from crates/common/src/types.rs. Run scripts/docs/regen.py to refresh.

These are the typed enums exposed across the REST API, the WebSocket protocol, the CLI, and the database. The wire format column shows the exact string a client must send or expect.

PermissionLevel

Granular per-application permission. Ordered: None < View < Operate < Edit < Manage < Owner. Effective permission is the maximum of direct grant, every team grant, and the user's organisation role.

Source comment: Permission levels (per application). Ordered: None < View < Operate < Edit < Manage < Owner.

Variant Wire format Numeric value Description
None "none" 0 —
View "view" 1 —
Operate "operate" 2 —
Edit "edit" 3 —
Manage "manage" 4 —
Owner "owner" 5 —

ComponentState

The 8 FSM states a component can be in. See the FSM reference for the transition rules.

Source comment: The 8 possible states for a component in the FSM.

Variant Wire format Numeric value Description
Unknown "UNKNOWN" — —
Running "RUNNING" — —
Degraded "DEGRADED" — —
Failed "FAILED" — —
Stopped "STOPPED" — —
Starting "STARTING" — —
Stopping "STOPPING" — —
Unreachable "UNREACHABLE" — —

ComponentType

Catalogue tag used by the map renderer to pick an icon and by the import wizard to group components.

Source comment: Component types.

Variant Wire format Numeric value Description
Database "database" — —
Middleware "middleware" — —
Appserver "appserver" — —
Webfront "webfront" — —
Service "service" — —
Batch "batch" — —
Custom "custom" — —

CheckType

The four kinds of agent-side checks. Only Health drives the FSM; the others are informational and surface in the diagnostic page.

Source comment: Types of checks that can be run on a component.

Variant Wire format Numeric value Description
Health "health" — —
Integrity "integrity" — —
PostStart "post_start" — —
Infrastructure "infrastructure" — —

CheckStatus

Outcome of a diagnostic-level check. Feeds the diagnostic-recommendation matrix.

Source comment: Status for a diagnostic check level.

Variant Wire format Numeric value Description
Ok "OK" — —
Fail "FAIL" — —
NotAvailable "NOT_AVAILABLE" — —

DiagnosticRecommendation

Output of core::diagnostic::ComponentDiagnosis — what the system suggests doing about a degraded component.

Source comment: Diagnostic recommendation based on the 3-level assessment matrix.

Variant Wire format Numeric value Description
Healthy "Healthy" — —
Restart "Restart" — —
AppRebuild "AppRebuild" — —
InfraRebuild "InfraRebuild" — —
Unknown "Unknown" — —

ClusterMode

How a multi-host component is represented. Aggregate trusts an external aggregator (F5, Oracle SCAN). FanOut makes each member a first-class entity with its own FSM and history.

Source comment: How cluster members contribute to the parent component's state.

Variant Wire format Numeric value Description
Aggregate "aggregate" — External aggregation: the component-level check_cmd is assumed to already aggregate over hosts (F5, Oracle SCAN, JMX, etc.). cluster_size / cluster_nodes (V035) are cosmetic.
FanOut "fan_out" — Per-member execution: each cluster_members row is a first-class entity with its own agent, commands, FSM and history.

ClusterHealthPolicy

When cluster_mode = FanOut, how to derive the parent component's state from member states.

Source comment: Policy that derives the parent component's state from member states (only meaningful when cluster_mode = FanOut).

Variant Wire format Numeric value Description
AllHealthy "all_healthy" — All RUNNING → RUNNING; any non-RUNNING → DEGRADED; 0 RUNNING → FAILED.
AnyHealthy "any_healthy" — Any RUNNING → RUNNING; 0 RUNNING → FAILED.
Quorum "quorum" — count(RUNNING) ≥ ⌈N/2⌉+1 → RUNNING; else DEGRADED; 0 RUNNING → FAILED.
ThresholdPct "threshold_pct" — %RUNNING ≥ min_healthy_pct → RUNNING; ≥50% → DEGRADED; else FAILED.

SwitchoverPhase

The six phases of a DR switchover, executed sequentially with rollback available after each one. See the User Guide.

Source comment: Switchover phases for DR failover.

Variant Wire format Numeric value Description
Prepare "PREPARE" — —
Validate "VALIDATE" — —
StopSource "STOP_SOURCE" — —
Sync "SYNC" — —
StartTarget "START_TARGET" — —
Commit "COMMIT" — —

SwitchoverMode

How aggressively to fail over. Full moves every component; Selective moves a chosen subset; Progressive moves component groups in sequence with explicit go/no-go between groups.

Source comment: Switchover modes.

Variant Wire format Numeric value Description
Full "FULL" — —
Selective "SELECTIVE" — —
Progressive "PROGRESSIVE" — —

OrgRole

Organisation-wide role. Admin is an implicit Owner on every application; the other roles imply nothing — application-level permissions are still required to operate.

Source comment: User roles within an organization.

Variant Wire format Numeric value Description
Admin "admin" — —
Operator "operator" — —
Editor "editor" — —
Viewer "viewer" — —

UpdateStatus

Status of an in-progress agent self-update (air-gap bundle distribution).

Source comment: Status of an in-progress agent binary update.

Variant Wire format Numeric value Description
Downloading "downloading" — —
Verifying "verifying" — —
Applying "applying" — —
Complete "complete" — —
Failed "failed" — —