Hibernating Linux virtual machines

Applies to: ✔️ Linux VMs

Important

Azure Virtual Machines - Hibernation is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

Hibernation allows you to pause VMs that aren't being used and save on compute costs. It's an effective cost management feature for scenarios such as:

• Virtual desktops, dev/test servers, and other scenarios where the VMs don't need to run 24/7.
• Systems with long boot times due to memory intensive applications. These applications can be initialized on VMs and hibernated. These “prewarmed” VMs can then be quickly started when needed, with the applications already up and running in the desired state.

How hibernation works

To learn how hibernation works, check out the hibernation overview.

Supported configurations

Hibernation support is limited to certain VM sizes and OS versions. Make sure you have a supported configuration before using hibernation.

For a list of hibernation compatible VM sizes, check out the supported VM sizes section in the hibernation overview.

Supported Linux distros

The following Linux operating systems support hibernation:

• Ubuntu 22.04 LTS
• Ubuntu 20.04 LTS
• Ubuntu 18.04 LTS
• Debian 11
• Debian 10 (with backports kernel)

Prerequisites and configuration limitations

• Hibernation isn't supported with Trusted Launch for Linux VMs

For general limitations, Azure feature limitations supported VM sizes, and feature prerequisites check out the "Supported configurations" section in the hibernation overview.

Creating a Linux VM with hibernation enabled

To hibernate a VM, you must first enable the feature while creating the VM. You can only enable hibernation for a VM on initial creation. You can't enable this feature after the VM is created.

To enable hibernation during VM creation, you can use the Azure portal, CLI, PowerShell, ARM templates and API.

Portal

To enable hibernation in the Azure portal, check the 'Enable hibernation' box during VM creation.

CLI

To enable hibernation in the Azure CLI, create a VM by running the following az vm create command with --enable-hibernation set to true.

 az vm create --resource-group myRG \
   --name myVM \
   --image Win2019Datacenter \
   --public-ip-sku Standard \
   --size Standard_D2s_v5 \
   --enable-hibernation true 

PowerShell

To enable hibernation when creating a VM with PowerShell, run the following command:

New-AzVm ` 
 -ResourceGroupName 'myRG' ` 
 -Name 'myVM' ` 
 -Location 'East US' ` 
 -VirtualNetworkName 'myVnet' ` 
 -SubnetName 'mySubnet' ` 
 -SecurityGroupName 'myNetworkSecurityGroup' ` 
 -PublicIpAddressName 'myPublicIpAddress' ` 
 -Size Standard_D2s_v5 ` 
 -Image Win2019Datacenter ` 
 -HibernationEnabled ` 
 -OpenPorts 80,3389 

REST

First, create a VM with hibernation enabled

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}?api-version=2021-11-01

Your output should look something like this:

{
  "location": "eastus",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v5"
    },
    "additionalCapabilities": {
      "hibernationEnabled": true
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2019-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Standard_LRS"
        },
        "name": "vmOSdisk",
        "createOption": "FromImage"
      }
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
          "properties": {
            "primary": true
          }
        }
      ]
    },
    "osProfile": {
      "adminUsername": "{your-username}",
      "computerName": "{vm-name}",
      "adminPassword": "{your-password}"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
        "enabled": true
      }
    }
  }
}

To learn more about REST, check out an API example

Once you've created a VM with hibernation enabled, you need to configure the guest OS to successfully hibernate your VM.

Configuring hibernation in the guest OS

After ensuring that your VM configuration is supported, you can enable hibernation on your Linux VM using one of two options:

Option 1: LinuxHibernateExtension

Option 2: hibernation-setup-tool

LinuxHibernateExtension

Note

If you've already installed the hibernation-setup-tool you do not need to install the LinuxHibernateExtension. These are redundant methods to enable hibernation on a Linux VM.

When you create a Hibernation-enabled VM via the Azure portal, the LinuxHibernationExtension is automatically installed on the VM.

If the extension is missing, you can manually install the LinuxHibernateExtension on your Linux VM to configure the guest OS for hibernation.

Note

Azure extensions are currently disabled by default for Debian images. To re-enable extensions, check the Linux hibernation troubleshooting guide.

CLI

To install LinuxHibernateExtension with the Azure CLI, run the following command:

az vm extension set -n LinuxHibernateExtension --publisher Microsoft.CPlat.Core --version 1.0 \    --vm-name MyVm --resource-group MyResourceGroup --enable-auto-upgrade true

PowerShell

To install LinuxHibernateExtension with PowerShell, run the following command:

Set-AzVMExtension -Publisher Microsoft.CPlat.Core -ExtensionType LinuxHibernateExtension -VMName <VMName> -ResourceGroupName <RGNAME> -Name "LinuxHibernateExtension" -Location <Location> -TypeHandlerVersion 1.0

Hibernation-setup-tool

Note

If you've already installed the LinuxHibernateExtension you do not need to install the hibernation-setup-tool. These are redundant methods to enable hibernation on a Linux VM.

You can install the hibernation-setup-tool package on your Linux VM from Microsoft’s Linux software repository at packages.microsoft.com.

To use the Linux software repository, follow the instructions at Linux package repository for Microsoft software.

Ubuntu 18.04 (Bionic)

To use the repository in Ubuntu 18.04, open git bash and run this command:

curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -

sudo apt-add-repository https://packages.microsoft.com/ubuntu/18.04/prod

sudo apt-get update

Ubuntu 20.04 (Focal)

To use the repository in Ubuntu 20.04, open git bash and run this command:

curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo tee etc/apt/trusted.gpg.d/microsoft.asc

sudo apt-add-repository https://packages.microsoft.com/ubuntu/20.04/prod

sudo apt-get update

To install the package, run this command in git bash:

sudo apt-get install hibernation-setup-tool

Once the package installs successfully, your Linux guest OS is configured for hibernation. You can also create a new Azure Compute Gallery Image from this VM and use the image to create VMs. VMs created with this image have the hibernation package preinstalled, simplifying your VM creation experience.

Hibernate a VM

Once a VM with hibernation enabled has been created and the guest OS is configured for hibernation, you can hibernate the VM through the Azure portal, the Azure CLI, PowerShell, or REST API.

Portal

To hibernate a VM in the Azure portal, click the 'Hibernate' button on the VM Overview page.

CLI

To hibernate a VM in the Azure CLI, run this command:

az vm deallocate --resource-group TestRG --name TestVM --hibernate true 

PowerShell

To hibernate a VM in PowerShell, run this command:

Stop-AzVM -ResourceGroupName "TestRG" -Name "TestVM" -Hibernate      

After running the above command, enter 'Y' to continue:

Virtual machine stopping operation 

This cmdlet will stop the specified virtual machine. Do you want to continue? 

[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y 

REST API

To hibernate a VM using the REST API, run this command:

POST 
https://management.azure.com/subscriptions/.../providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate?hibernate=true&api-version=2021-03-01 

View state of hibernated VM

Portal

To view the state of a VM in the portal, check the 'Status' on the overview page. It should report as "Hibernated (deallocated)"

PowerShell

To view the state of a VM using PowerShell:

Get-AzVM -ResourceGroupName "testRG" -Name "testVM" -Status 

Your output should look something like this:

ResourceGroupName : testRG 
Name              : testVM 
HyperVGeneration  : V1 
Disks[0]          :  
  Name            : testVM_OsDisk_1_d564d424ff9b40c987b5c6636d8ea655 
  Statuses[0]     :  
    Code          : ProvisioningState/succeeded 
    Level         : Info 
    DisplayStatus : Provisioning succeeded 
    Time          : 4/17/2022 2:39:51 AM 
Statuses[0]       :  
  Code            : ProvisioningState/succeeded 
  Level           : Info 
  DisplayStatus   : Provisioning succeeded 
  Time            : 4/17/2022 2:39:51 AM 
Statuses[1]       :  
  Code            : PowerState/deallocated 
  Level           : Info 
  DisplayStatus   : VM deallocated 
Statuses[2]       :  
  Code            : HibernationState/Hibernated 
  Level           : Info 
  DisplayStatus   : VM hibernated 

CLI

To view the state of a VM using Azure CLI:

az vm get-instance-view -g MyResourceGroup -n myVM

Your output should look something like this:

{
  "additionalCapabilities": {
    "hibernationEnabled": true,
    "ultraSsdEnabled": null
  },
  "hardwareProfile": {
    "vmSize": "Standard_D2s_v5",
    "vmSizeProperties": null
  },
  "instanceView": {
    "assignedHost": null,
    "bootDiagnostics": null,
    "computerName": null,
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "displayStatus": "Provisioning succeeded",
        "level": "Info",
        "message": null,
        "time": "2022-04-17T02:39:51.122866+00:00"
      },
      {
        "code": "PowerState/deallocated",
        "displayStatus": "VM deallocated",
        "level": "Info",
        "message": null,
        "time": null
      },
      {
        "code": "HibernationState/Hibernated",
        "displayStatus": "VM hibernated",
        "level": "Info",
        "message": null,
        "time": null
      }
    ],
  },

REST API

To view the state of a VM using REST API, run this command:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView?api-version=2020-12-01 

Your output should look something like this:

"statuses":  
[ 
    { 
      "code": "ProvisioningState/succeeded", 
      "level": "Info", 
      "displayStatus": "Provisioning succeeded", 
      "time": "2019-10-14T21:30:12.8051917+00:00" 
    }, 
    { 
      "code": "PowerState/deallocated", 
      "level": "Info", 
      "displayStatus": "VM deallocated" 
    }, 
   { 
      "code": "HibernationState/Hibernated", 
      "level": "Info", 
      "displayStatus": "VM hibernated" 
    } 
] 

Start hibernated VMs

You can start hibernated VMs just like how you would start a stopped VM. This can be done through the Azure portal, the Azure CLI, PowerShell, or REST API.

Portal

To start a hibernated VM using the Azure portal, click the 'Start' button on the VM Overview page.

CLI

To start a hibernated VM using the Azure CLI, run this command:

az vm start -g MyResourceGroup -n MyVm

PowerShell

To start a hibernated VM using PowerShell, run this command:

Start-AzVM -ResourceGroupName "ExampleRG" -Name "ExampleName"

REST API

To start a hibernated VM using the REST API, run this command:

POST https://management.azure.com/subscriptions/../providers/Microsoft.Compute/virtualMachines/{vmName}/start?api-version=2020-12-01 

Deploy hibernation enabled VMs from the Azure Compute Gallery

VMs created from Compute Gallery images can also be enabled for hibernation. Ensure that the OS version associated with your Gallery image supports hibernation on Azure. Refer to the list of supported OS versions.

To create VMs with hibernation enabled using Gallery images, you'll first need to create a new image definition with the hibernation property enabled. Once this feature property is enabled on the Gallery Image definition, you can create an image version and use that image version to create hibernation enabled VMs.

Note

For specialized Windows images, the page file location must be set to C: drive in order for Azure to successfully configure your guest OS for hibernation. If you're creating an Image version from an existing VM, you should first move the page file to the OS disk and then use the VM as the source for the Image version.

Portal

To create an image definition with the hibernation property enabled, select the checkmark for 'Enable hibernation'.

CLI

az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features IsHibernateSupported=true

PowerShell

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$galleryImageDefinitionName = "myImage"
$location = "eastus"
$publisherName = "GreatPublisher"
$offerName = "GreatOffer"
$skuName = "GreatSku"
$description = "My gallery"
$IsHibernateSupported = @{Name='IsHibernateSupported';Value='True'} 
$features = @($IsHibernateSupported)
New-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $galleryImageDefinitionName -Location $location -Publisher $publisherName -Offer $offerName -Sku $skuName -OsState "Generalized" -OsType "Windows" -Description $description -Feature $features

Deploy hibernation enabled VMs from an OS disk

VMs created from OS disks can also be enabled for hibernation. Ensure that the OS version associated with your OS disk supports hibernation on Azure. Refer to the list of supported OS versions.

To create VMs with hibernation enabled using OS disks, ensure that the OS disk has the hibernation property enabled. Refer to API example to enable this property on OS disks. Once the hibernation property is enabled on the OS disk, you can create hibernation enabled VMs using that OS disk.

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-12-01

{
  "properties": {
    "supportsHibernation": true
  }
}

Troubleshooting

Refer to the Hibernate troubleshooting guide and the Linux VM hibernation troubleshooting guide for more information.

FAQs

Refer to the Hibernate FAQs for more information.

Next steps

• Learn more about Azure billing
• Look into Azure VM Sizes