Managing gateway updates using the Amazon Storage Gateway console - Amazon Storage Gateway
Turn maintenance updates on or offModify the gateway maintenance window schedule
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Amazon FSx File Gateway documentation has been moved to What is Amazon FSx File Gateway?

Volume Gateway documentation has been moved to What is Volume Gateway?

Tape Gateway documentation has been moved to What is Tape Gateway?

Managing gateway updates using the Amazon Storage Gateway console

Storage Gateway consists of a managed cloud services component, and a gateway appliance component that you deploy either on-premises, or on an Amazon EC2 instance in the Amazon cloud. Amazon updates the cloud services component as needed without causing disruption to deployed gateways.

Your deployed gateway appliances also require periodic updates. Updates can include operating system and software upgrades, fixes to address stability, performance, and security, and access to new features. All updates are cumulative, and upgrade gateways to the current version when applied.

Gateway appliances receive updates on a recurring basis, and applying these updates may cause a brief disruption of service. The gateway's VM host doesn't need to reboot during updates, but the gateway will be unavailable for a short period while the software appliance updates and restarts.

Important

You should treat the Storage Gateway appliance as a managed virtual machine, and should not attempt to access or modify its installation in any way. Attempting to install or update any software packages using methods other than the normal gateway update mechanism (for example, SSM or hypervisor tools) may cause the gateway to malfunction.

You can configure your gateways to apply maintenance updates automatically during scheduled maintenance windows, or wait until you initiate them manually. When you deploy and activate your gateway, a default weekly maintenance window schedule is set. You can modify the maintenance window schedule at any time. When updates are available, the gateway Details tab displays a maintenance message. You can also see the date and time that the last successful update was applied on the Details tab.

Note

Certain important updates will sometimes be applied according to the maintenance window schedule, even if regular maintenance updates are turned off.

Before any update is applied to your gateway, Amazon notifies you with a message on the Storage Gateway console and your Amazon Health Dashboard. For more information, see Amazon Health Dashboard. To modify the email address that software update notifications are sent, go to the Managing an Amazon account page and update the alternate contact for "operations'.

The procedures in the following sections describe how to manage gateway updates using the Storage Gateway console. To manage these settings programmatically using the API, see UpdateMaintenanceStartTime in the Storage Gateway API Reference.

Turn maintenance updates on or off

When maintenance updates are turned on, your gateway automatically applies these updates according to the configured maintenance window schedule. For more information, see Modify the gateway maintenance window schedule.

If maintenance updates are turned off, the gateway will not apply these updates automatically, but you can still apply them manually using the Storage Gateway console, API, or CLI. Certain important updates will sometimes be applied during your configured maintenance window, regardless of this setting.

To turn maintenance updates on or off for a specific gateway:

  1. Open the Storage Gateway console at https://console.amazonaws.cn/storagegateway/home.

  2. On the navigation pane, choose Gateways, and then choose the gateway for which you want to configure maintenance updates.

  3. Choose Actions, and then choose Edit maintenance settings.

  4. For Maintenance updates, select On or Off.

  5. Choose Save changes when finished.

You can verify the updated setting on the Details tab for the selected gateway in the Storage Gateway console.

Modify the gateway maintenance window schedule

If maintenance updates are turned on, your gateway automatically applies these updates according the maintenance window schedule. Certain important updates will sometimes be applied during your configured maintenance window, regardless of the maintenance updates setting.

To modify the maintenance window schedule for a specific gateway:

  1. Open the Storage Gateway console at https://console.amazonaws.cn/storagegateway/home.

  2. On the navigation pane, choose Gateways, and then choose the gateway for which you want to configure maintenance updates.

  3. Choose Actions, and then choose Edit maintenance settings.

  4. Under Maintenance window start time, do the following:

    1. For Schedule, choose Weekly or Monthly to set the maintenance window cadence.

    2. If you choose Weekly, modify the values for Day of the week and Time to set the specific point during each week when the maintenance window will begin.

      If you choose Monthly, modify the values for Day of the month and Time to set the specific point during each month when the maintenance window will begin.

      Note

      The maximum value that can be set for day of the month is 28. It is not possible to set the maintenance schedule to start on days 29 through 31.

      If you receive an error while configuring this setting, it might mean that your gateway software is out of date. Considering updating your gateway manually first, and then attempt to configure the maintenance window schedule again.

  5. Choose Save changes when finished.

You can verify the updated settings on the Details tab for the selected gateway in the Storage Gateway console.