add new server maintenance mode script/docs

amidaware · Nov 22, 2024 · c9eb2f6 · c9eb2f6
1 parent 02be7fe
commit c9eb2f6
Showing 1 changed file with 19 additions and 4 deletions.
diff --git a/docs/functions/maintenance_mode.md b/docs/functions/maintenance_mode.md
@@ -12,10 +12,25 @@ To enable maintenance mode for a single agent, **Right Click** on the agent and
 
 ## Putting server into maintenance mode
 
+* Follow the instructions at the top of [Management Commands](../management_cmds.md) page to activate the python virtual env
+
+* Download the management command:
+
 ```
-# put all in maintenance mode
-echo "from agents.models import Agent; Agent.objects.update(maintenance_mode=True)" | /rmm/api/env/bin/python /rmm/api/tacticalrmm/manage.py shell
+wget -O /rmm/api/tacticalrmm/core/management/commands/server_maint_mode.py 'https://raw.githubusercontent.com/amidaware/tacticalrmm/refs/heads/develop/api/tacticalrmm/core/management/commands/server_maint_mode.py'
+```
+
+* Run the management command using one of the options below:
 
-# revert back to normal
-echo "from agents.models import Agent; Agent.objects.update(maintenance_mode=False)" | /rmm/api/env/bin/python /rmm/api/tacticalrmm/manage.py shell
 ```
+python manage.py server_maint_mode [options]
+```
+
+| Options              | Description                                                                                                                                                   |
+|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `--enable`        | **Enable Maintenance Mode.** Sets all agents to maintenance mode and saves their current states.                                                            |
+| `--disable`       | **Disable Maintenance Mode.** Restores agents to their previous states before maintenance mode was enabled.                                                 |
+| `--force-enable`  | **Force Enable Maintenance Mode.** Unconditionally sets all agents to maintenance mode, ignoring any previously saved states.                              |
+| `--force-disable` | **Force Disable Maintenance Mode.** Unconditionally disables maintenance mode for all agents, removing any saved state information.                        |
+
+**Note**: Only one of the above options should be used at a time to avoid conflicts.