Configure Auto-Update

Auto-Update lets you update Access Gateway automatically to the latest available version on a schedule that you choose.

Auto-Update is enabled by default in Access Gateway instances created from the 2025.5.4 release and later versions. It's disabled by default in instances that were upgraded to the 2025.5.4 release from an earlier version.

To use schedules, you create one on the primary node, and then it runs on the admin node. If the admin node finds an update, it checks the time of the latest backup. The admin node runs a backup if the latest one is more than two hours old. Next, it triggers all the other nodes sequentially to download and install the update. If an update fails, Auto-Update is disabled in the cluster. In-progress updates are allowed to continue running. Unstarted updates aren't triggered to start.

If you don't want to install the latest version, turn Auto-Update off, and then upgrade to a specific version. See Upgrade Access Gateway to a specific version.

Access Gateway is backwards-compatible with one previous version. If you want to use Auto-Update but your version is two or more versions behind the latest one, upgrade Access Gateway one version higher. Run tests to identify and resolve any issues in that version. Continue upgrading and testing until you reach the latest version, and then turn Auto-Update on.

Follow these recommendations when you work with Auto-Update:

  • Don't run backups and Auto-Update at the same time. If you use schedules, set your schedule to run at least an hour before or after a backup schedule.
  • Run automated tests on your Access Gateway environments after Auto-Update runs to verify that the update hasn't changed any of your configurations.
  • Consider running Auto-Update in pre-production environments at an earlier time than in production environments. This enables you to identify and resolve issues found by your automated tests before an update is applied to your production environments.

Auto-Update generates Access Gateway metrics. See the Cluster section of Supported metrics.

Before you begin

  • Create a snapshot of your system in your virtual machine environment before you run Auto-Update, including before scheduled runs. This ensures that you have a stable environment to revert to if something fails when Auto-Update runs.
  • Set up alerts to be notified if Auto-Update fails. See Monitor Access Gateway .
  • Optional. Access Gateway runs on a single node when High Availability isn't configured. It goes offline when it restarts after an update. To avoid outages during updates, configure High Availability on multiple nodes. See High availability.

Enable Auto-Update

  1. Connect to the Access Gateway Management console on the primary node.
  2. Press 5 - System.
  3. Press 4 - Update.
  4. Press 3 - Configure Auto-Update.
  5. Press 1 - Enable Auto-Update.
  6. Press y to confirm.

Disable Auto-Update

  1. Connect to the Access Gateway Management console on the primary node.
  2. Press 5 - System.
  3. Press 4 - Update.
  4. Press 3 - Configure Auto-Update.
  5. Press 1 - Disable Auto-Update.

Configure an update schedule

By default, Auto-Update runs at 1:00 a.m. every morning. To create your own schedule, edit the default schedule.

  1. Connect to the Access Gateway Management console on the primary node.
  2. Press 5 - System.
  3. Press 4 - Update.
  4. Press 3 - Configure Auto-Update.
  5. Press 2 - Set Schedule.
  6. Press 1 - Edit Schedule.
  7. Enter the date and time at which the automatic updates occur. Create the schedule using any of these units:
    • Minute: Enter 0 (zero) to 59.
    • Hour: Enter 0 (zero) to 23. The hour uses the 24-hour clock and runs according to the time on the server where the primary node is hosted.
    • Day of the month: Enter 1–31.
    • Month: Enter 1–12, or the first three letters of a month: jan, feb, mar, and so on.
    • Day of the week: Enter 0 (zero) to 7, or the first three letters of a day: sun, mon, tue, and so on.

    Format the schedule expression using the UNIX cron format. Enter a value for a unit, and then press the space key to move to the next unit. Enter an asterisk (*) and then press the space key to skip a unit. Here are some examples:

    • To run Auto-Update on May 15 at 4:30 a.m, enter this expression:

      30 <space> 4 <space> 15 <space> 5 <space> * <space>

    • To run Auto-Update on Tuesdays at 4:30 a.m., enter this expression:

      30 <space> 4 <space> * <space> * <space> 2 <space> or 30 <space> 4 <space> * <space> * <space> tue <space>

    • To run Auto-Update at 11:00 p.m. (23:00 hours) on the 15th day of each month, enter this expression:

      0 <space> 23 <space> 15 <space> * <space> * <space>

    See Cron Examples for more examples.

  8. Press Enter when you've finished entering the expression.
  9. Press y to confirm.

Edit an update schedule

  1. Connect to the Access Gateway Management console on the primary node.
  2. Press 5 - System.
  3. Press 4 - Update.
  4. Press 3 - Configure Auto-Update.
  5. Press 2 - Set Schedule.
  6. Press 1 - Edit Schedule.
  7. Configure the schedule according to the instructions in Configure an update schedule.

View the progress of an update that's in progress

  1. Connect to the Access Gateway Management console on the primary node.
  2. Press 5 - System.
  3. Press 4 - Update.
  4. Press 3 - Configure Auto-Update.
  5. Press 3 - View Auto-Update Progress.

If a failure occurs during an update, Auto-Update is disabled and the Status field displays Failed Update. Enable Auto-Update again to continue with your update schedule in the future. Press 1 - Enable Auto-Update.

Turn Auto-Update off

If you turn Auto-Update off while an update is running, the update continues until it has finished, and you can't check its status. Wait until any updates are finished before turning off Auto-Update.

  1. Connect to the Access Gateway Management console on the primary node.
  2. Press 5 - System.
  3. Press 4 - Update.
  4. Press 3 - Configure Auto-Update.
  5. Press 4 - Stop Auto-Update.
  6. Press y to confirm.