blob: fef59cd3d9237994d4da4abb586289548c9f511f [file] [log] [blame]
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="working-with-snapshots">
<title>Working with Volume Snapshots</title>
<para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>,
<emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold"
>KVM</emphasis>)</para>
<para>&PRODUCT; supports snapshots of disk volumes. Snapshots are a point-in-time capture of virtual machine disks. Memory and CPU states are not captured. If you are using the Oracle VM hypervisor, you can not take snapshots, since OVM does not support them.</para>
<para>Snapshots may be taken for volumes, including both root and data disks (except when the Oracle VM hypervisor is used, which does not support snapshots). The administrator places a limit on the number of stored snapshots per user. Users can create new volumes from the snapshot for recovery of particular files and they can create templates from snapshots to boot from a restored disk.</para>
<para>Users can create snapshots manually or by setting up automatic recurring snapshot policies. Users can also create disk volumes from snapshots, which may be attached to a VM like any other disk volume. Snapshots of both root disks and data disks are supported. However, &PRODUCT; does not currently support booting a VM from a recovered root disk. A disk recovered from snapshot of a root disk is treated as a regular data disk; the data on recovered disk can be accessed by attaching the disk to a VM.</para>
<para>A completed snapshot is copied from primary storage to secondary storage, where it is stored until deleted or purged by newer snapshot.</para>
<section id="how-to-volume-snapshot">
<title>How to Snapshot a Volume</title>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or administrator.</para></listitem>
<listitem><para>In the left navigation bar, click Storage.</para></listitem>
<listitem><para>In Select View, be sure Volumes is selected.</para></listitem>
<listitem><para>Click the name of the volume you want to snapshot.</para></listitem>
<listitem><para>Click the Snapshot button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/SnapshotButton.png" format="PNG"/>
</imageobject>
</inlinemediaobject></para></listitem>
</orderedlist>
</section>
<xi:include href="automatic-snapshot-creation-retention.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="incremental-snapshots-backup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="volume-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="snapshot-restore.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="snapshot-throttling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="snapshot-performance-vmware.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</section>