System Maintenance Mode#

CLI commands are available to place the VOSS Automate system in a maintenance mode.

Maintenance Mode Commands#

  • system maintenance-mode start - Put system into maintenance mode

    Running this command prompts for confirmation and then shows:

    System is now in maintenance mode
    

    When the system is in maintenance mode:

    • Upon login on the CLI or when obtaining a health report, e.g. diag health, the message is then shown:

      SYSTEM IN MAINTENANCE MODE
      
    • No scheduled Platform tasks will be started while in maintenance mode.

    • No scheduled Automate transactions will be started while in maintenance mode.

  • system maintenance-mode status - Check the status of the system maintenance mode

    The command returns two messages - current status and scheduled status, for example

    System is in maintenance mode
    System is not scheduled for maintenance mode
    
  • system maintenance-mode stop - Take system out of maintenance mode

    Running the command requests confirmation and then shows:

    System is now out of maintenance mode
    
    • Scheduled tasks will resume once the system is out of maintenance mode.