vsphere_virtual_machine_snapshot

The vsphere_virtual_machine_snapshot resource can be used to manage snapshots for a virtual machine.

For more information on managing snapshots and how they work in VMware, see here.

NOTE: A snapshot in VMware differs from traditional disk snapshots, and can contain the actual running state of the virtual machine, data for all disks that have not been set to be independent from the snapshot (including ones that have been attached via the attach parameter to the vsphere_virtual_machine disk sub-resource), and even the configuration of the virtual machine at the time of the snapshot. Virtual machine, disk activity, and configuration changes post-snapshot are not included in the original state. Use this resource with care! Neither VMware nor HashiCorp recommends retaining snapshots for a extended period of time and does NOT recommend using them as as backup feature. For more information on the limitation of virtual machine snapshots, see here.

Example Usage

resource "vsphere_virtual_machine_snapshot" "demo1" {
  virtual_machine_uuid = "9aac5551-a351-4158-8c5c-15a71e8ec5c9"
  snapshot_name        = "Snapshot Name"
  description          = "This is Demo Snapshot"
  memory               = "true"
  quiesce              = "true"
  remove_children      = "false"
  consolidate          = "true"
}

Argument Reference

The following arguments are supported:

NOTE: All attributes in the vsphere_virtual_machine_snapshot resource are immutable and force a new resource if changed.

• virtual_machine_uuid - (Required) The virtual machine UUID.
• snapshot_name - (Required) The name of the snapshot.
• description - (Required) A description for the snapshot.
• memory - (Required) If set to true, a dump of the internal state of the virtual machine is included in the snapshot.
• quiesce - (Required) If set to true, and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system in the virtual machine.
• remove_children - (Optional) If set to true, the entire snapshot subtree is removed when this resource is destroyed.
• consolidate - (Optional) If set to true, the delta disks involved in this snapshot will be consolidated into the parent when this resource is destroyed.

Attribute Reference

The only attribute this resource exports is the resource id, which is set to the managed object reference ID of the snapshot.