Fix the issue where rancher-machine does not clean up vSphere VMs that are in failed status

drivers/vmwarevsphere/create.go

@@ -144,6 +144,13 @@ func (d *Driver) createLegacy() error {
 	if err != nil {
 		return err
 	}
+	log.Info("Fetching MachineID ...")
+	// save the machine id as soon as the VM is created
+	if _, err = d.GetMachineId(); err != nil {
+		// no need to return the error, it is not a blocker for creating the machine,
+		// we will fetch the machineID again after starting the VM
+		log.Warnf("[createLegacy] failed to fetch MachineID for %s: %v", d.MachineName, err)
+	}
 
 	log.Infof("Uploading Boot2docker ISO ...")
 	vm := object.NewVirtualMachine(c.Client, info.Result.(types.ManagedObjectReference))
@@ -274,6 +281,14 @@ func (d *Driver) createFromVmName() error {
 		return err
 	}
 
+	log.Info("Fetching MachineID ...")
+	// save the machine id as soon as the VM is created
+	if _, err = d.GetMachineId(); err != nil {
+		// no need to return the error, it is not a blocker for creating the machine,
+		// we will fetch the machineID again after starting the VM
+		log.Warnf("[createFromVmName] failed to fetch MachineID for %s: %v", d.MachineName, err)
+	}
+
 	// Retrieve the new VM
 	vm := object.NewVirtualMachine(c.Client, info.Result.(types.ManagedObjectReference))
 	if err := d.addNetworks(vm, d.networks); err != nil {
@@ -357,6 +372,14 @@ func (d *Driver) createFromLibraryName() error {
 		return err
 	}
 
+	log.Info("Fetching MachineID ...")
+	// save the machine id as soon as the VM is created
+	if _, err = d.GetMachineId(); err != nil {
+		// no need to return the error, it is not a blocker for creating the machine,
+		// we will fetch the machineID again after starting the VM
+		log.Warnf("[createFromLibraryName] failed to fetch MachineID for %s: %v", d.MachineName, err)
+	}
+
 	// At this point, the VM is deployed from content library with defaults from template
 	// Reconfiguration of the VM based on driver inputs follows
 

drivers/vmwarevsphere/vsphere.go

@@ -453,6 +453,7 @@ func (d *Driver) Kill() error {
 func (d *Driver) Remove() error {
 	if d.MachineId == "" {
 		// no guid from config, nothing in vsphere to delete
+		log.Info("MachineID is empty, skipping removing VM")
 		return nil
 	}
 

libmachine/libmachine.go

@@ -136,6 +136,13 @@ func (api *Client) Create(h *host.Host) error {
 	log.Info("Creating machine...")
 
 	if err := api.performCreate(h); err != nil {
+		if h.Driver.DriverName() == "vmwarevsphere" {
+			// it is possible that the VM is instantiated but fails to bootstrap,
+			// save the machine to the store, so the VM and associated resources can be found and destroyed later
+			if err := api.Save(h); err != nil {
+				log.Warnf("Error saving host to store after creation fails: %s", err)
+			}
+		}
 		return fmt.Errorf("Error creating machine: %s", err)
 	}