Skip to content

Status, Modes and Types

The constants used in Edge Builder indicate the status, type and mode of the components and operations, as described below.

Node Status

The status of an edge node can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Pending Edge node is awaiting deployment
This is the initial status for non-SSH edge nodes
2 Deploying Edge node is being deployed for the first time
This is the initial status for SSH edge nodes
3 Error Edge node is down and active events are present
4 Warning Edge node is up and active events are present
5 Down Edge node is down and no events are present
6 Up Edge node is fully operational
7 Deleting Edge node is being deleted

App Status

The status of an app can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Creating App is being created on the edge node
2 Created App has been created on the edge node
3 Stopped App is stopped
4 Starting App is starting
5 Running App is running
6 Stopping App is stopping
7 Removing App is being removed from the edge node
8 Restarting App is restarting
9 Error App has errors. Check for events

Script Status

The status of a script can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Pending Script hasn't started yet
2 Running Script is running
3 Done Script is has finished running
4 Error Script has encountered an error
5 Cancelled Script has been cancelled

Debug Status

The status of debug mode can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Off Debug mode is disabled
2 Starting Debug mode is starting
3 On Debug mode is enabled Use Portainer to access the edge node
4 Stopping Debug mode is being disabled

Alert Status

The status of alert can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Deploying Alert is being deployed
2 Disabled Alert is currently disabled
3 Error Alert has errors. Check for events
4 Removing Alert is being removed
5 Enabled Alert is currently enabled

Event Types

Event types can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Internal Events associated with the Edge Builder server
2 Resource Events associated with a resource on the edge node
3 App Events associated with apps
4 Node Events associated with edge nodes
5 Script Events associated with scripts

Metrics Mode

The metrics mode to use can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Local Metrics are stored locally on the edge node
2 Live Live metrics are forwarded for user access and stored locally on the edge node
3 Forward Metrics within a defined time slice are forwarded for user access and stored locally on the edge node
4 Transiting Status when the metrics mode is transitioning from one mode to another. Can only be set internally

ScriptDefinition Types

The format of the scriptDefinition type can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Python Python script
2 Shell Shell script

Alert Types

The format of the Alert type can be represented using either the integer or string, as described in the following table:

Integer String Description
1 Deploying Alert is deploying
2 Disabled Alert is disabled
3 Error Alert is in an error state
4 Removing Alert is being removed
5 Enabled Alert is enabled