Class: Chef::Knife::VsphereVmSnapshot

Inherits:
BaseVsphereCommand show all
Includes:
SearchHelper
Defined in:
lib/chef/knife/vsphere_vm_snapshot.rb

Overview

Manage snapshots of a virtual machine

Instance Method Summary collapse

Methods included from SearchHelper

#get_all_objects, #get_all_vm_objects, #get_vm_by_name, #get_vm_host_by_name

Methods inherited from BaseVsphereCommand

#choose_datastore, common_options, #conn_opts, #datacenter, #fatal_exit, #find_all_in_folder, #find_datastore, #find_datastorecluster, #find_datastores_regex, #find_device, #find_folder, #find_in_folder, #find_network, #find_pool, #find_pool_folder, #find_pools_and_clusters, #get_config, #get_password_from_stdin, #get_path_to_object, #linux?, #number_to_human_size, #password, #tcp_test_port, #tcp_test_port_vm, #traverse_folders_for_computeresources, #traverse_folders_for_dc, #traverse_folders_for_pools, #vim_connection, #windows?

Methods inherited from Chef::Knife

#log_verbose?

Instance Method Details

#display_node(node, current) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/chef/knife/vsphere_vm_snapshot.rb', line 138

def display_node(node, current)
  children = node.childSnapshotList.map { |item| display_node(item, current) }
  snapshot_tree = { "SnapshotName" => node.name,
                    "SnapshotId" => node.id,
                    "SnapshotDescription" => node.description,
                    "SnapshotCreationDate" => node.createTime.iso8601,
                    "Children" => children }
  snapshot_tree["IsCurrentSnapshot"] = true if node.snapshot == current
  snapshot_tree
end

#find_node(tree, name) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/chef/knife/vsphere_vm_snapshot.rb', line 125

def find_node(tree, name)
  snapshot = nil
  tree.each do |node|
    if node.name == name
      snapshot = node.snapshot
      break
    elsif !node.childSnapshotList.empty?
      snapshot = find_node(node.childSnapshotList, name)
    end
  end
  snapshot
end

#run ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/chef/knife/vsphere_vm_snapshot.rb', line 68

def run
  $stdout.sync = true

  vmname = @name_args[0]
  if vmname.nil?
    show_usage
    ui.fatal("You must specify a virtual machine name")
    exit 1
  end

  vm = get_vm_by_name(vmname, get_config(:folder)) || fatal_exit("Could not find #{vmname}")

  if vm.snapshot
    snapshot_list = vm.snapshot.rootSnapshotList
    current_snapshot = vm.snapshot.currentSnapshot
  end

  if get_config(:list) && vm.snapshot
    ui.output(snapshot_list.map { |i| display_node(i, current_snapshot) })
  end

  if get_config(:create_new_snapshot)
    snapshot_task = vm.CreateSnapshot_Task(name: get_config(:create_new_snapshot),
                                           description: get_config(:snapshot_description),
                                           memory: get_config(:dump_memory),
                                           quiesce: get_config(:quiesce))
    snapshot_task = snapshot_task.wait_for_completion if get_config(:wait)
    snapshot_task
  end

  if get_config(:remove_named_snapshot)
    ss_name = get_config(:remove_named_snapshot)
    snapshot = find_node(snapshot_list, ss_name)
    puts "Found snapshot #{ss_name} removing."
    snapshot_task = snapshot.RemoveSnapshot_Task(removeChildren: false)
    snapshot_task = snapshot_task.wait_for_completion if get_config(:wait)
    snapshot_task
  end

  if get_config(:revert_current_snapshot)
    puts "Reverting to Current Snapshot"
    vm.RevertToCurrentSnapshot_Task(suppressPowerOn: false).wait_for_completion
    if get_config(:power)
      vm.PowerOnVM_Task.wait_for_completion
      puts "Powered on virtual machine #{vmname}"
    end
  end

  return unless get_config(:revert_snapshot)
  ss_name = get_config(:revert_snapshot)
  snapshot = find_node(snapshot_list, ss_name)
  snapshot.RevertToSnapshot_Task(suppressPowerOn: false).wait_for_completion
  return unless get_config(:power)
  vm.PowerOnVM_Task.wait_for_completion
  puts "Powered on virtual machine #{vmname}"
end