VirtualMachineSnapshot

Scope: Namespaced
Version: v1alpha2

VirtualMachineSnapshot provides a resource for creating snapshots of virtual machines.

  • apiVersion
    string

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind
    string

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata
    object
  • spec
    object

    Required value

    • spec.keepIPAddress
      string

      Required value

      KeepIPAddress defines whether to save the IP address of the virtual machine or not:

      • Always - when creating a snapshot, the virtual machine’s IP address will be converted from Auto to Static and saved.
      • Never - when creating a snapshot, the virtual machine’s IP address will not be converted.

      Default: "Always"

      Allowed values: Always, Never

    • spec.requiredConsistency
      boolean

      Required value

      Create a snapshot of a virtual machine only if it is possible to freeze the machine through the agent.

      If value is true, the snapshot of the virtual machine will be taken only in the following scenarios:

      • the virtual machine is powered off.
      • the virtual machine with an agent, and the freeze operation was successful.

      Default: true

    • spec.virtualMachineName
      string

      Required value

      The name of virtual machine to take snapshot.

    • spec.volumeSnapshotClasses
      array of objects
      • spec.volumeSnapshotClasses.storageClassName
        string

        Required value

        The StorageClass name associated with VolumeSnapshotClass.

      • spec.volumeSnapshotClasses.volumeSnapshotClassName
        string

        Required value

        The name of VolumeSnapshotClass to use for virtual disk snapshotting.