#!/bin/sh
#
# vmsnapshot.sh
#
# This is a simple script to create a snapshot of each running bhyve VM.
#
# It will creates a list of all hosts' VMs; process one-by-one by stoppping, creating the
# snapshot with the current date and time, and restarting the VM.
#
# It won't snapshot VMs that are not running.
#
# cron tasks can be created to run this script on a regular schedule. No parameters are needed.
# crontab tasks entries will control when the script is to be executed.
#
# A log will be created with the main steps, but you can add anything to the log by executing
# the function log() with the string to be logged.
#
# ----------------------------------------------------------------------------
# License
#
# Copyright (c) 2017 by Al Mello
#
# Feedbacks welcome to: al_mello @ hotmail(dot)com
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# ------------------------------------------------------------------------------
#######################
# Variables
#######################
now=$(date +"%Y-%m-%d_%H:%M:%S") # Run date
maindir=/raid/vm/ # bhyve VM's directory
log_file=$maindir"/vmsnapshot.log" # Log file
vmbhyve=/usr/local/sbin/vm # Path for vm-bhyve
#######################
# Process log entries
#######################
log()
{
timestamp=$(date +"[%Y-%m-%d %H:%M:%S]")
parm="$1"
if [ -e $log_file ];
then
echo "$timestamp bhyve vmsnapshot: $parm" >> $log_file
else
echo "$timestamp copy bhyve vmsnapshot: Log file created" > $log_file
echo "$timestamp copy bhyve vmsnapshot: $parm" >> $log_file
fi
}
#######################
# Main
#######################
log "*** vmsnapshot Script started ***"
#
# List existing VMs
#
$vmbhyve list > vms.asc
#
# Determine number of existing VMs
#
nr_lines=$(wc -l < vms.asc)
nr_vms=$(($nr_lines - 1))
#
# Exit if no VMs on this host
#
if [ "$nr_vms" -lt "1" ]; then
log "No VMs defined on this host"
log "*** End of script ***"
exit
fi
#
# Process each VM
#
cur_line=2
while [ "$cur_line" -le "$nr_lines" ]; do
line=$(sed -n "$cur_line{p;q;}" 'vms.asc')
vm_name=$(echo $line | awk '{print $1}')
flag=$(echo $line | awk '{print $NF}')
if [ "$flag" = "Stopped" ]; then
log "VM $vm_name is stopped"
cur_line=$((cur_line+1))
else
log "Creating snapshot of $vm_name"
vm_pid=$(echo $line | awk '{print $NF}' | tr -d '()')
$vmbhyve stop $vm_name
while kill -0 $vm_pid 2> /dev/null; do
sleep 1
vm_pid=$(echo $line | awk '{print $NF}' | tr -d '()')
done
$vmbhyve snapshot $vm_name@$now
$vmbhyve start $vm_name
cur_line=$((cur_line+1))
fi
done
log "*** End of script ***"
