RUAL Documentation

get instance state

This block is part of the virtualisation group and was last modified in core v13.0.9.

get instance state v13.0.9

Get state of a instance on the LXD server.

Pin Pin Type Default
flow
flow
Connectionrequired
The LXD connection
lxdconnection
Instance namerequired
The name of the instance to request the state for.
value
Pin Pin Type Example
flow
flow
Connectionrequired
The LXD connection
lxdconnection
Success
If successful, this pin returns true.
condition
Status
The current status of the instance..
value
CPU Usage
The current CPU usage of the instance.
object
Disk Usage
The current disk usage of the instance.
object
Memory Usage
The current memory usage of the instance.
object
Network state
The current network state of the instance.
object
Processes Running
The quantity of processes that are currently running on the instance.
number
Stats
Stats RUAL generated of this state.
object
Mounts
Mounts of the instance.
array
Error
Error message if the instance state could not be requested.
value

Core Releases

v13.0.9 This block was introduced in v13.0.9, click here to see the release notes.
Back to virtualisation Return to the main group to view all sub-groups Back to LXD Return to the group to view all blocks within this group