vm_retirement_emails.rb

#
# Description: This method sends out retirement emails when the following events are raised:
# Events: vm_retire_warn, vm_retired, vm_entered_retirement
# Model Notes:
# 1. to_email_address - used to specify an email address in the case where the
#    vm's owner does not have an  email address. To specify more than one email
#    address separate email address with commas. (I.e. admin@example.com,user@example.com)
# 2. from_email_address - used to specify an email address in the event the
#    requester replies to the email
# 3. signature - used to stamp the email with a custom signature
#

# Support multiple warning emails.
# Set the number of days from the retirement date for the next warning.
def update_retirement_warning(vm)
  # Get the warning days from the current object. Default to 30/7/1 if not found in object
  warn_days_1 = $evm.object['warn_days_1'] || 30
  warn_days_2 = $evm.object['warn_days_2'] || 7
  warn_days_3 = $evm.object['warn_days_3'] || 1

  # Get the number of days warning for the vm that is currently set.
  current_retire_days = vm.retirement_warn

  $evm.log("info", "Found VM: <#{vm.name}> has current_retire_days of #{current_retire_days}")
  
  if current_retire_days > warn_days_1
    vm.retirement_warn = warn_days_1
  elsif current_retire_days == warn_days_1 || current_retire_days > warn_days_2
    vm.retirement_warn = warn_days_2
  elsif current_retire_days == warn_days_2 || current_retire_days > warn_days_3
    vm.retirement_warn = warn_days_3
  else
    vm.retirement_warn = nil
  end
 
  $evm.log("info","VM: <#{vm.name}> Retirement Warning reset to <#{vm.retirement_warn}>")
end  


# Look in the current object for a VM
vm = $evm.object['vm']
if vm.nil?
  vm_id = $evm.object['vm_id'].to_i
  vm = $evm.vmdb('vm', vm_id) unless vm_id == 0
end

# Look in the Root Object for a VM
if vm.nil?
  vm = $evm.root['vm']
  if vm.nil?
    vm_id = $evm.root['vm_id'].to_i
    vm = $evm.vmdb('vm', vm_id) unless vm_id == 0
  end
end

# Look in the Root Object for a Provision/Request
prov = $evm.root['miq_provision_request'] || $evm.root['miq_provision']
vm = prov.vm if prov && vm.nil?

raise "User not specified" if vm.nil?

# Get VM Name
vm_name = vm['name']

# Look at the Event Type in the Current Object or in the Root Object
event_type = $evm.object['event'] || $evm.root['event_type']

# Get VM Owner Name and Email
evm_owner_id = vm.attributes['evm_owner_id']
owner = nil
owner = $evm.vmdb('user', evm_owner_id) unless evm_owner_id.nil?

# to_email_address from owner.email then from model if nil
if owner
  to = owner.email
else
  to = $evm.object['to_email_address']
end

######################################
#
# VM Retirement Warning Email
#
######################################
if event_type == "vm_retire_warn"

  # Get from_email_address from model unless specified below
  from = nil
  from ||= $evm.object['from_email_address']

  # Get signature from model unless specified below
  signature = nil
  signature ||= $evm.object['signature']

  # email subject
  subject = "VM Retirement Warning for #{vm_name}"

  # Build email body
  body = "Hello, "
  body += "<br><br>Your virtual machine: [#{vm_name}] will be retired on [#{vm['retires_on']}]."
  body += "<br><br>If you need to use this virtual machine past this date please request"
  body += "<br><br>an extension by contacting Support."
  body += "<br><br> Thank you,"
  body += "<br> #{signature}"

  update_retirement_warning(vm)
end

######################################
#
# VM Retirement Exended Email
#
######################################
if event_type == "vm_retire_extend"

  # Get from_email_address from model unless specified below
  from = nil
  from ||= $evm.object['from_email_address']

  # Get signature from model unless specified below
  signature = nil
  signature ||= $evm.object['signature']

  # email subject
  subject = "VM Retirement Extended for #{vm_name}"

  # Build email body
  body = "Hello, "
  body += "<br><br>Your virtual machine: [#{vm_name}] will now be retired on [#{vm['retires_on']}]."
  body += "<br><br>If you need to use this virtual machine past this date please request"
  body += "<br><br>an extension by contacting Support."
  body += "<br><br> Thank you,"
  body += "<br> #{signature}"

  update_retirement_warning(vm)
end

######################################
#
# VM has entered Retirement Email
#
######################################
if event_type == "vm_entered_retirement"

  # Get from_email_address from model unless specified below
  from = nil
  from ||= $evm.object['from_email_address']

  # Get signature from model unless specified below
  signature = nil
  signature ||= $evm.object['signature']

  # email subject
  subject = "VM #{vm_name} has entered retirement"

  # Build email body
  body = "Hello, "
  body += "<br><br>Your virtual machine named [#{vm_name}] has been retired."
  body += "<br><br>You will have up to 3 days to un-retire this VM. Afterwhich time the VM will be deleted."
  body += "<br><br> Thank you,"
  body += "<br> #{signature}"
end

######################################
#
#  VM Retirement Email
#
######################################
if event_type == "vm_retired"

  # Get from_email_address from model unless specified below
  from = nil
  from ||= $evm.object['from_email_address']

  # Get signature from model unless specified below
  signature = nil
  signature ||= $evm.object['signature']

  # email subject
  subject = "VM Retirement Alert for #{vm_name}"

  # Build email body
  body = "Hello, "
  body += "<br><br>Your virtual machine named [#{vm_name}] has been retired."
  body += "<br><br> Thank you,"
  body += "<br> #{signature}"
end

$evm.log("info", "Sending email to <#{to}> from <#{from}> subject: <#{subject}>")
$evm.execute('send_email', to, from, subject, body)