def clone_snapshot(api, config, vm_from_list):
"""
Clone snapshot into a new vm
:param api: ovirtsdk api
:param config: Configuration
:vm: VM to clone
"""
vm_clone_name = vm_from_list + config.get_vm_middle() + config.get_vm_suffix()
vm = api.vms.get(vm_from_list)
snapshots = vm.snapshots.list(description=config.get_snapshot_description())
if not snapshots:
logger.error("!!! No snapshot found !!!")
has_errors = True
snapshot=snapshots[0]
# Find the storage domain where the disks should be created:
sd = api.storagedomains.get(name=config.get_destination_domain())
# Find the image identifiers of the disks of the snapshot, as
# we need them in order to explicitly indicate that we want
# them created in a different storage domain:
disk_ids = []
for current in snapshot.disks.list():
disk_ids.append(current.get_id())
# Prepare the list of disks for the operation to create the
# snapshot,explicitly indicating for each of them the storage
# domain where it should be created:
disk_list = []
for disk_id in disk_ids:
disk = params.Disk(
image_id=disk_id,
storage_domains=params.StorageDomains(
storage_domain=[
params.StorageDomain(
id=sd.get_id(),
),
],
),
)
disk_list.append(disk)
snapshot_param = params.Snapshot(id=snapshot.id)
snapshots_param = params.Snapshots(snapshot=[snapshot_param])
logger.info("Clone into VM (%s) started ..." % vm_clone_name)
if not config.get_dry_run():
api.vms.add(params.VM(
name=vm_clone_name,
memory=vm.get_memory(),
cluster=api.clusters.get(config.get_cluster_name()),
snapshots=snapshots_param,
disks=params.Disks(
disk=disk_list,
)
)
)
VMTools.wait_for_vm_operation(api, config, "Cloning", vm_from_list)
logger.info("Cloning finished")
def create_vm_to_export(self, vm, new_name, desc):
try:
self.snapshot = self.api.vms.get(vm).snapshots.list(
description=desc)[0]
self.snapshots = params.Snapshots(
snapshot=[params.Snapshot(id=self.snapshot.id)])
self.cluster = self.api.clusters.get(
id=self.api.vms.get(vm).cluster.id)
self.api.vms.add(
params.VM(name=new_name,
snapshots=self.snapshots,
cluster=self.cluster,
template=self.api.templates.get(name="Blank"),
delete_protected=False))
self.__wait(new_name, 0)
except RequestError as err:
print("Error: {} Reason: {}".format(err.status, err.reason))
raise Exception(14)
def main(argv):
usage = "backup.py -c <config.cfg>"
try:
opts, args = getopt(argv, "hc:d")
debug = False
if not opts:
print usage
sys.exit(1)
for opt, arg in opts:
if (opt == "-h") or (opt == "--help"):
print usage
sys.exit(0)
elif opt in ("-c"):
config_file = arg
elif opt in ("-d"):
debug = True
except GetoptError:
print usage
sys.exit(1)
global config
config = Config(config_file, debug)
time_start = int(time.time())
has_errors = False
# Connect to server
connect()
# Test if all VM names are valid
for vm_from_list in config.get_vm_names():
if not api.vms.get(vm_from_list):
print "!!! There are no VM with the following name in your cluster: " + vm_from_list
api.disconnect()
sys.exit(1)
vms_with_failures = list(config.get_vm_names())
for vm_from_list in config.get_vm_names():
config.clear_vm_suffix()
vm_clone_name = vm_from_list + config.get_vm_middle(
) + config.get_vm_suffix()
# Check VM name length limitation
length = len(vm_clone_name)
if length > config.get_vm_name_max_length():
print "!!! VM name with middle and suffix are to long (size: " + str(
length) + ", allowed " + str(
config.get_vm_name_max_length()) + ") !!!"
Logger.log("VM name: " + vm_clone_name)
api.disconnect()
sys.exit(1)
Logger.log("Start backup for: " + vm_from_list)
try:
# Get the VM
vm = api.vms.get(vm_from_list)
# Cleanup: Delete the cloned VM
VMTools.delete_vm(api, config, vm_from_list)
# Delete old backup snapshots
VMTools.delete_snapshots(vm, config, vm_from_list)
# Determine disks to snapshot
vm_disks = []
try:
config_disks = config.get_vm_disks()[vm_from_list]
except KeyError:
config_disks = None
for vm_disk in vm.disks.list():
if config_disks is None or vm_disk.get_name() in config_disks:
vm_disks.append(vm_disk)
# Create a VM snapshot:
try:
Logger.log("Snapshot creation started ...")
if not config.get_dry_run():
vm.snapshots.add(
params.Snapshot(
description=config.get_snapshot_description(),
vm=vm,
disks=params.Disks(disk=vm_disks)))
VMTools.wait_for_snapshot_operation(vm, config, "creation")
Logger.log("Snapshot created")
except Exception as e:
Logger.log("Can't create snapshot for VM: " + vm_from_list)
Logger.log("DEBUG: " + str(e))
has_errors = True
continue
# Clone the snapshot into a VM
snapshots = vm.snapshots.list(
description=config.get_snapshot_description())
if not snapshots:
Logger.log("!!! No snapshot found")
has_errors = True
continue
snapshot = snapshots[0]
snapshot_param = params.Snapshot(id=snapshot.id)
snapshots_param = params.Snapshots(snapshot=[snapshot_param],
collapse_snapshots=True)
if config.get_vm_clone_domain() is not None:
clone_sd = api.storagedomains.get(
name=config.get_vm_clone_domain())
if not clone_sd:
Logger.log(
"!!! Unknown storage domain value for vm_clone_domain")
has_errors = True
continue
vm_clone_disks = []
for disk in snapshot.disks.list():
vm_clone_disks.append(
params.Disk(image_id=disk.get_id(),
storage_domains=params.StorageDomains(
storage_domain=[clone_sd])))
else:
vm_clone_disks = snapshot.disks.list()
Logger.log("Clone into VM started ...")
if not config.get_dry_run():
api.vms.add(
params.VM(name=vm_clone_name,
memory=vm.get_memory(),
cluster=api.clusters.get(
config.get_cluster_name()),
snapshots=snapshots_param,
disks=params.Disks(disk=vm_clone_disks)))
VMTools.wait_for_vm_operation(api, config, "Cloning",
vm_from_list)
Logger.log("Cloning finished")
# Delete backup snapshots
VMTools.delete_snapshots(vm, config, vm_from_list)
# Delete old backups
VMTools.delete_old_backups(api, config, vm_from_list)
# Export the VM
try:
vm_clone = api.vms.get(vm_clone_name)
Logger.log("Export started ...")
if not config.get_dry_run():
vm_clone.export(
params.Action(storage_domain=api.storagedomains.get(
config.get_export_domain())))
VMTools.wait_for_vm_operation(api, config, "Exporting",
vm_from_list)
Logger.log("Exporting finished")
except Exception as e:
Logger.log("Can't export cloned VM (" + vm_clone_name +
") to domain: " + config.get_export_domain())
Logger.log("DEBUG: " + str(e))
has_errors = True
continue
# Delete the VM
VMTools.delete_vm(api, config, vm_from_list)
time_end = int(time.time())
time_diff = (time_end - time_start)
time_minutes = int(time_diff / 60)
time_seconds = time_diff % 60
Logger.log("Duration: " + str(time_minutes) + ":" +
str(time_seconds) + " minutes")
Logger.log("VM exported as " + vm_clone_name)
Logger.log("Backup done for: " + vm_from_list)
vms_with_failures.remove(vm_from_list)
except errors.ConnectionError as e:
Logger.log("!!! Can't connect to the server" + str(e))
connect()
continue
except errors.RequestError as e:
Logger.log("!!! Got a RequestError: " + str(e))
has_errors = True
continue
except Exception as e:
Logger.log("!!! Got unexpected exception: " + str(e))
api.disconnect()
sys.exit(1)
Logger.log("All backups done")
if vms_with_failures:
Logger.log("Backup failured for:")
for i in vms_with_failures:
Logger.log(" " + i)
if has_errors:
Logger.log(
"Some errors occured during the backup, please check the log file")
api.disconnect()
sys.exit(1)
# Disconnect from the server
api.disconnect()
def main(argv):
p = create_argparser()
opts = p.parse_args(argv)
config_arguments = arguments_to_dict(opts)
global config
with opts.config_file:
config = Config(opts.config_file, opts.debug, config_arguments)
initialize_logger(
config.get_logger_fmt(),
config.get_logger_file_path(),
opts.debug,
)
time_start = int(time.time())
has_errors = False
# Connect to server
connect()
# Add all VM's to the config file
if opts.all_vms:
vms = api.vms.list(max=400)
config.set_vm_names([vm.name for vm in vms])
# Update config file
if opts.config_file.name != "<stdin>":
config.write_update(opts.config_file.name)
# Add VM's with the tag to the vm list
if opts.vm_tag:
vms = api.vms.list(max=400, query="tag=" + opts.vm_tag)
config.set_vm_names([vm.name for vm in vms])
# Update config file
if opts.config_file.name != "<stdin>":
config.write_update(opts.config_file.name)
# Test if data center is valid
if api.datacenters.get(config.get_datacenter_name()) is None:
logger.error("!!! Check the datacenter_name in the config")
api.disconnect()
sys.exit(1)
# Test if config export_domain is valid
if api.storagedomains.get(config.get_export_domain()) is None:
logger.error("!!! Check the export_domain in the config")
api.disconnect()
sys.exit(1)
# Test if config cluster_name is valid
if api.clusters.get(config.get_cluster_name()) is None:
logger.error("!!! Check the cluster_name in the config")
api.disconnect()
sys.exit(1)
# Test if config storage_domain is valid
if api.storagedomains.get(config.get_storage_domain()) is None:
logger.error("!!! Check the storage_domain in the config")
api.disconnect()
sys.exit(1)
# Test if all VM names are valid
for vm_from_list in config.get_vm_names():
if not api.vms.get(vm_from_list):
logger.error(
"!!! There are no VM with the following name in your cluster: %s",
vm_from_list)
api.disconnect()
sys.exit(1)
# Test if config vm_middle is valid
if not config.get_vm_middle():
logger.error("!!! It's not valid to leave vm_middle empty")
api.disconnect()
sys.exit(1)
vms_with_failures = list(config.get_vm_names())
for vm_from_list in config.get_vm_names():
config.clear_vm_suffix()
vm_clone_name = vm_from_list + config.get_vm_middle(
) + config.get_vm_suffix()
# Check VM name length limitation
length = len(vm_clone_name)
if length > config.get_vm_name_max_length():
logger.error(
"!!! VM name with middle and suffix are to long (size: %s, allowed %s) !!!",
length, config.get_vm_name_max_length())
logger.info("VM name: %s", vm_clone_name)
api.disconnect()
sys.exit(1)
logger.info("Start backup for: %s", vm_from_list)
try:
VMTools.check_storage_domain_status(api,
config.get_datacenter_name(),
config.get_export_domain())
# Cleanup: Delete the cloned VM
VMTools.delete_vm(api, config, vm_from_list)
# Get the VM
vm = api.vms.get(vm_from_list)
if vm is None:
logger.warn(
"The VM (%s) doesn't exist anymore, skipping backup ...",
vm_from_list)
continue
# Delete old backup snapshots
VMTools.delete_snapshots(vm, config, vm_from_list)
# Check free space on the storage
VMTools.check_free_space(api, config, vm)
# Create a VM snapshot:
try:
logger.info("Snapshot creation started ...")
if not config.get_dry_run():
vm.snapshots.add(
params.Snapshot(
description=config.get_snapshot_description(),
vm=vm,
persist_memorystate=config.get_persist_memorystate(
),
))
VMTools.wait_for_snapshot_operation(vm, config, "creation")
logger.info("Snapshot created")
except Exception as e:
logger.info("Can't create snapshot for VM: %s", vm_from_list)
logger.info("DEBUG: %s", e)
has_errors = True
continue
# Workaround for some SDK problems see issue #17
time.sleep(10)
# Clone the snapshot into a VM
snapshots = vm.snapshots.list(
description=config.get_snapshot_description())
if not snapshots:
logger.error("!!! No snapshot found !!!")
has_errors = True
continue
snapshot_param = params.Snapshot(id=snapshots[0].id)
snapshots_param = params.Snapshots(snapshot=[snapshot_param])
logger.info("Clone into VM (%s) started ..." % vm_clone_name)
if not config.get_dry_run():
api.vms.add(
params.VM(name=vm_clone_name,
memory=vm.get_memory(),
cluster=api.clusters.get(
config.get_cluster_name()),
snapshots=snapshots_param))
VMTools.wait_for_vm_operation(api, config, "Cloning",
vm_from_list)
logger.info("Cloning finished")
# Delete backup snapshots
VMTools.delete_snapshots(vm, config, vm_from_list)
# Delete old backups
if (config.get_backup_keep_count()):
VMTools.delete_old_backups(api, config, vm_from_list)
if (config.get_backup_keep_count_by_number()):
VMTools.delete_old_backups_by_number(api, config, vm_from_list)
# Export the VM
try:
vm_clone = api.vms.get(vm_clone_name)
logger.info("Export of VM (%s) started ..." % vm_clone_name)
if not config.get_dry_run():
vm_clone.export(
params.Action(storage_domain=api.storagedomains.get(
config.get_export_domain())))
VMTools.wait_for_vm_operation(api, config, "Exporting",
vm_from_list)
logger.info("Exporting finished")
except Exception as e:
logger.info("Can't export cloned VM (%s) to domain: %s",
vm_clone_name, config.get_export_domain())
logger.info("DEBUG: %s", e)
has_errors = True
continue
# Delete the VM
VMTools.delete_vm(api, config, vm_from_list)
time_end = int(time.time())
time_diff = (time_end - time_start)
time_minutes = int(time_diff / 60)
time_seconds = time_diff % 60
logger.info("Duration: %s:%s minutes", time_minutes, time_seconds)
logger.info("VM exported as %s", vm_clone_name)
logger.info("Backup done for: %s", vm_from_list)
vms_with_failures.remove(vm_from_list)
except errors.ConnectionError as e:
logger.error("!!! Can't connect to the server %s", e)
connect()
continue
except errors.RequestError as e:
logger.error("!!! Got a RequestError: %s", e)
has_errors = True
continue
except Exception as e:
logger.error("!!! Got unexpected exception: %s", e)
api.disconnect()
sys.exit(1)
logger.info("All backups done")
if vms_with_failures:
logger.info("Backup failured for:")
for i in vms_with_failures:
logger.info(" %s", i)
if has_errors:
logger.info(
"Some errors occured during the backup, please check the log file")
api.disconnect()
sys.exit(1)
# Disconnect from the server
api.disconnect()
def snapclone_to_export(api, vm):
"""Generates a snapshot of a VM, clones it, then exports, and removes the temporary VM"""
description = "Preexport-%s" % time.mktime(time.gmtime())
# GET VM
cluster = api.clusters.get(id=vm.cluster.id)
if not vm:
print "VM %s not found" % vm.name
sys.exit(1)
# Create new snapshot
if options.verbosity > 0:
print "Creating snapshot..."
vm.snapshots.add(params.Snapshot(description=description, vm=vm))
# Wait for snapshot to finish
i = 0
while api.vms.get(name=vm.name).status.state == "image_locked":
if options.verbosity > 0:
print "waiting for snapshot to finish %s..." % i
time.sleep(10)
i = i + 1
# Get snapshot object
snap = api.vms.get(name=vm.name).snapshots.list(description=description)[0]
# Build snapshots collection
snapshots = params.Snapshots(snapshot=[params.Snapshot(id=snap.id)])
# Create new VM from SNAPSHOT (NOT WORKING AT THE MOMENT)
newname = "%s-deleteme" % vm.name
if options.verbosity > 0:
print "Creating new VM based on snapshot..."
api.vms.add(
params.VM(name=newname,
snapshots=snapshots,
cluster=cluster,
template=api.templates.get(name="Blank")))
# Wait for create to finish
i = 0
while api.vms.get(name=newname).status.state == "image_locked":
if options.verbosity > 0:
print "Waiting for creation to finish..."
i = i + 1
time.sleep(10)
# DC
dc = api.datacenters.get(id=cluster.data_center.id)
# Get Export domain from our DC
export = None
for sd in dc.storagedomains.list():
if sd.type_ == "export":
export = sd
if not export:
print "Export domain required, and none found, exitting..."
sys.exit(1)
if options.verbosity > 0:
print "Exporting cloned VM to export domain..."
# Export cloned VM to export domain for backup
api.vms.get(name=newname).export(params.Action(storage_domain=export))
# Wait for create to finish
i = 0
while api.vms.get(name=newname).status.state == "image_locked":
i = i + 1
if options.verbosity > 0:
print "waiting for export to finish..."
time.sleep(10)
if options.verbosity > 0:
print "Deleting temporary VM..."
api.vms.get(name=newname).delete()
if options.verbosity > 0:
print "Deleting temporary snapshot..."
print "NOT YET SUPPORTED BY RHEV API"
return
def main(argv):
try:
opts, args = getopt(argv, "hac:d")
debug = False
all_vms = False
if not opts:
usage()
for opt, arg in opts:
if (opt == "-h") or (opt == "--help"):
usage()
elif opt in ("-c"):
config_file = arg
elif opt in ("-d"):
debug = True
elif opt in ("-a"):
all_vms = True
except GetoptError:
usage()
global config
config = Config(config_file, debug)
time_start = int(time.time())
has_errors = False
# Connect to server
connect()
# Add all VM's to the config file
if all_vms:
vms = api.vms.list(max=400)
vmlist.get_vm_list(vms, config_file)
config = Config(config_file, debug)
# Test if config export_domain is valid
if api.storagedomains.get(config.get_export_domain()) is None:
print "!!! Check the export_domain in the config"
api.disconnect()
sys.exit(1)
# Test if config cluster_name is valid
if api.clusters.get(config.get_cluster_name()) is None:
print "!!! Check the cluster_name in the config"
api.disconnect()
sys.exit(1)
# Test if config storage_domain is valid
if api.storagedomains.get(config.get_storage_domain()) is None:
print "!!! Check the storage_domain in the config"
api.disconnect()
sys.exit(1)
# Test if all VM names are valid
for vm_from_list in config.get_vm_names():
if not api.vms.get(vm_from_list):
print "!!! There are no VM with the following name in your cluster: " + vm_from_list
api.disconnect()
sys.exit(1)
# Test if config vm_middle is valid
if not config.get_vm_middle():
print "!!! It's not valid to leave vm_middle empty"
api.disconnect()
sys.exit(1)
vms_with_failures = list(config.get_vm_names())
for vm_from_list in config.get_vm_names():
config.clear_vm_suffix()
vm_clone_name = vm_from_list + config.get_vm_middle(
) + config.get_vm_suffix()
# Check VM name length limitation
length = len(vm_clone_name)
if length > config.get_vm_name_max_length():
print "!!! VM name with middle and suffix are to long (size: " + str(
length) + ", allowed " + str(
config.get_vm_name_max_length()) + ") !!!"
Logger.log("VM name: " + vm_clone_name)
api.disconnect()
sys.exit(1)
Logger.log("Start backup for: " + vm_from_list)
try:
# Get the VM
vm = api.vms.get(vm_from_list)
# Cleanup: Delete the cloned VM
VMTools.delete_vm(api, config, vm_from_list)
# Delete old backup snapshots
VMTools.delete_snapshots(vm, config, vm_from_list)
# Check free space on the storage
VMTools.check_free_space(api, config, vm)
# Create a VM snapshot:
try:
Logger.log("Snapshot creation started ...")
if not config.get_dry_run():
vm.snapshots.add(
params.Snapshot(
description=config.get_snapshot_description(),
vm=vm))
VMTools.wait_for_snapshot_operation(vm, config, "creation")
Logger.log("Snapshot created")
except Exception as e:
Logger.log("Can't create snapshot for VM: " + vm_from_list)
Logger.log("DEBUG: " + str(e))
has_errors = True
continue
# Workaround for some SDK problems see issue #17
time.sleep(10)
# Clone the snapshot into a VM
snapshots = vm.snapshots.list(
description=config.get_snapshot_description())
if not snapshots:
Logger.log("!!! No snapshot found")
has_errors = True
continue
snapshot_param = params.Snapshot(id=snapshots[0].id)
snapshots_param = params.Snapshots(snapshot=[snapshot_param])
Logger.log("Clone into VM started ...")
if not config.get_dry_run():
api.vms.add(
params.VM(name=vm_clone_name,
memory=vm.get_memory(),
cluster=api.clusters.get(
config.get_cluster_name()),
snapshots=snapshots_param))
VMTools.wait_for_vm_operation(api, config, "Cloning",
vm_from_list)
Logger.log("Cloning finished")
# Delete backup snapshots
VMTools.delete_snapshots(vm, config, vm_from_list)
# Delete old backups
VMTools.delete_old_backups(api, config, vm_from_list)
# Export the VM
try:
vm_clone = api.vms.get(vm_clone_name)
Logger.log("Export started ...")
if not config.get_dry_run():
vm_clone.export(
params.Action(storage_domain=api.storagedomains.get(
config.get_export_domain())))
VMTools.wait_for_vm_operation(api, config, "Exporting",
vm_from_list)
Logger.log("Exporting finished")
except Exception as e:
Logger.log("Can't export cloned VM (" + vm_clone_name +
") to domain: " + config.get_export_domain())
Logger.log("DEBUG: " + str(e))
has_errors = True
continue
# Delete the VM
VMTools.delete_vm(api, config, vm_from_list)
time_end = int(time.time())
time_diff = (time_end - time_start)
time_minutes = int(time_diff / 60)
time_seconds = time_diff % 60
Logger.log("Duration: " + str(time_minutes) + ":" +
str(time_seconds) + " minutes")
Logger.log("VM exported as " + vm_clone_name)
Logger.log("Backup done for: " + vm_from_list)
vms_with_failures.remove(vm_from_list)
except errors.ConnectionError as e:
Logger.log("!!! Can't connect to the server" + str(e))
connect()
continue
except errors.RequestError as e:
Logger.log("!!! Got a RequestError: " + str(e))
has_errors = True
continue
except Exception as e:
Logger.log("!!! Got unexpected exception: " + str(e))
api.disconnect()
sys.exit(1)
Logger.log("All backups done")
if vms_with_failures:
Logger.log("Backup failured for:")
for i in vms_with_failures:
Logger.log(" " + i)
if has_errors:
Logger.log(
"Some errors occured during the backup, please check the log file")
api.disconnect()
sys.exit(1)
# Disconnect from the server
api.disconnect()
