[req-changes] Added device config status

openwisp · Nov 19, 2024 · 12a58f5 · 12a58f5
1 parent e1e97fc
commit 12a58f5
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -35,6 +35,7 @@ the OpenWISP architecture.
     :maxdepth: 1
 
     user/intro.rst
+    user/device-config-status.rst
     user/templates.rst
     user/variables.rst
     user/device-groups.rst

diff --git a/docs/user/device-config-status.rst b/docs/user/device-config-status.rst
@@ -0,0 +1,33 @@
+Device Configuration Status
+===========================
+
+The possible values for the device's configuration status
+(``Device.config.status``) are explained below.
+
+``modified``
+------------
+
+The configuration of the device has been modified on OpenWISP, but the
+changes have not been applied to the device yet.
+
+``applied``
+-----------
+
+The device has applied the configuration changes made on OpenWISP.
+
+``error``
+---------
+
+The configuration on the device caused issues and it was rolled back.
+
+``deactivating``
+----------------
+
+The device has been marked for deactivation and the configuration will be
+removed from the device.
+
+``deactivated``
+---------------
+
+The device is deactivated and the configuration has been removed from the
+device.