github.com/vmware/govmomi@v0.51.0/cli/importx/ovf.go

// © Broadcom. All Rights Reserved.
// The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
// SPDX-License-Identifier: Apache-2.0

package importx

import (
	"context"
	"errors"
	"flag"
	"fmt"

	"github.com/vmware/govmomi/cli"
	"github.com/vmware/govmomi/cli/flags"
	"github.com/vmware/govmomi/fault"
	"github.com/vmware/govmomi/find"
	"github.com/vmware/govmomi/object"
	"github.com/vmware/govmomi/ovf/importer"
	"github.com/vmware/govmomi/property"
	"github.com/vmware/govmomi/vim25/mo"
	"github.com/vmware/govmomi/vim25/types"
)

type ovfx struct {
	*flags.DatastoreFlag
	*flags.HostSystemFlag
	*flags.OutputFlag
	*flags.ResourcePoolFlag
	*flags.FolderFlag

	*OptionsFlag

	Importer importer.Importer

	lease bool
	net   string // No need for *flags.NetworkFlag here
}

func init() {
	cli.Register("import.ovf", &ovfx{})
}

func (cmd *ovfx) Register(ctx context.Context, f *flag.FlagSet) {
	cmd.DatastoreFlag, ctx = flags.NewDatastoreFlag(ctx)
	cmd.DatastoreFlag.Register(ctx, f)
	cmd.HostSystemFlag, ctx = flags.NewHostSystemFlag(ctx)
	cmd.HostSystemFlag.Register(ctx, f)
	cmd.OutputFlag, ctx = flags.NewOutputFlag(ctx)
	cmd.OutputFlag.Register(ctx, f)
	cmd.ResourcePoolFlag, ctx = flags.NewResourcePoolFlag(ctx)
	cmd.ResourcePoolFlag.Register(ctx, f)
	cmd.FolderFlag, ctx = flags.NewFolderFlag(ctx)
	cmd.FolderFlag.Register(ctx, f)

	cmd.OptionsFlag, ctx = newOptionsFlag(ctx)
	cmd.OptionsFlag.Register(ctx, f)

	f.StringVar(&cmd.Importer.Name, "name", "", "Name to use for new entity")
	f.BoolVar(&cmd.Importer.VerifyManifest, "m", false, "Verify checksum of uploaded files against manifest (.mf)")
	f.BoolVar(&cmd.Importer.Hidden, "hidden", false, "Enable hidden properties")
	f.BoolVar(&cmd.lease, "lease", false, "Output NFC Lease only")
	f.StringVar(&cmd.net, "net", "", "Network")
}

func (cmd *ovfx) Process(ctx context.Context) error {
	if err := cmd.DatastoreFlag.Process(ctx); err != nil {
		return err
	}
	if err := cmd.HostSystemFlag.Process(ctx); err != nil {
		return err
	}
	if err := cmd.OutputFlag.Process(ctx); err != nil {
		return err
	}
	if err := cmd.ResourcePoolFlag.Process(ctx); err != nil {
		return err
	}
	if err := cmd.OptionsFlag.Process(ctx); err != nil {
		return err
	}
	if err := cmd.FolderFlag.Process(ctx); err != nil {
		return err
	}
	return nil
}

func (cmd *ovfx) Usage() string {
	return "PATH_TO_OVF"
}

func (cmd *ovfx) Run(ctx context.Context, f *flag.FlagSet) error {
	fpath, err := cmd.Prepare(f)
	if err != nil {
		return err
	}

	archive := &importer.FileArchive{Path: fpath}
	archive.Client = cmd.Importer.Client

	cmd.Importer.Archive = archive

	if err = cmd.Import(ctx, fpath); err != nil {
		if fault.Is(err, &types.OvfNoHostNic{}) {
			hint := "specify Network with '-net' or '-options'"
			return fmt.Errorf("%s (%s)", err.Error(), hint)
		}
		return err
	}
	return nil
}

func (cmd *ovfx) Import(ctx context.Context, fpath string) error {
	if cmd.net != "" {
		if len(cmd.Options.NetworkMapping) == 0 {
			env, err := importer.Spec(fpath, cmd.Importer.Archive, false, false)
			if err != nil {
				return err
			}

			cmd.Options.NetworkMapping = env.NetworkMapping
		}

		for i := range cmd.Options.NetworkMapping {
			cmd.Options.NetworkMapping[i].Network = cmd.net
		}
	}

	if cmd.lease {
		_, lease, err := cmd.Importer.ImportVApp(ctx, fpath, cmd.Options)
		if err != nil {
			return err
		}

		o, err := lease.Properties(ctx)
		if err != nil {
			return err
		}

		return cmd.WriteResult(o)
	}

	moref, err := cmd.Importer.Import(ctx, fpath, cmd.Options)
	if err != nil {
		return err
	}

	vm := object.NewVirtualMachine(cmd.Importer.Client, *moref)
	return cmd.Deploy(vm, cmd.OutputFlag)
}

func (cmd *ovfx) Prepare(f *flag.FlagSet) (string, error) {
	var err error

	args := f.Args()
	if len(args) != 1 {
		return "", errors.New("no file specified")
	}

	cmd.Importer.Log = cmd.OutputFlag.Log
	cmd.Importer.Client, err = cmd.DatastoreFlag.Client()
	if err != nil {
		return "", err
	}

	cmd.Importer.Datacenter, err = cmd.DatastoreFlag.Datacenter()
	if err != nil {
		return "", err
	}

	cmd.Importer.Datastore, err = cmd.datastore()
	if err != nil {
		return "", err
	}

	cmd.Importer.ResourcePool, err = cmd.ResourcePoolIfSpecified()
	if err != nil {
		return "", err
	}

	host, err := cmd.HostSystemIfSpecified()
	if err != nil {
		return "", err
	}

	if cmd.Importer.ResourcePool == nil {
		if host == nil {
			cmd.Importer.ResourcePool, err = cmd.ResourcePoolFlag.ResourcePool()
		} else {
			cmd.Importer.ResourcePool, err = host.ResourcePool(context.TODO())
		}
		if err != nil {
			return "", err
		}
	}

	cmd.Importer.Finder, err = cmd.DatastoreFlag.Finder()
	if err != nil {
		return "", err
	}

	cmd.Importer.Host, err = cmd.HostSystemIfSpecified()
	if err != nil {
		return "", err
	}

	// The folder argument must not be set on a VM in a vApp, otherwise causes
	// InvalidArgument fault: A specified parameter was not correct: pool
	if cmd.Importer.ResourcePool.Reference().Type != "VirtualApp" {
		cmd.Importer.Folder, err = cmd.FolderOrDefault("vm")
		if err != nil {
			return "", err
		}
	}

	if cmd.Importer.Name == "" {
		// Override name from options if specified
		if cmd.Options.Name != nil {
			cmd.Importer.Name = *cmd.Options.Name
		}
	} else {
		cmd.Options.Name = &cmd.Importer.Name
	}

	return f.Arg(0), nil
}

func (f *ovfx) datastore() (*object.Datastore, error) {
	ctx := context.Background()

	ds, err := f.Datastore()
	if err == nil {
		return ds, nil
	}
	if _, ok := err.(*find.NotFoundError); !ok {
		return nil, err
	}

	finder, err := f.DatastoreFlag.Finder()
	if err != nil {
		return nil, err
	}

	pod, err := finder.DatastoreCluster(ctx, f.Name)
	if err != nil {
		return nil, err
	}

	var folder mo.Folder

	err = pod.Properties(ctx, pod.Reference(), []string{"childEntity"}, &folder)
	if err != nil {
		return nil, err
	}

	if len(folder.ChildEntity) == 0 {
		return nil, fmt.Errorf("datastore cluster %q has no datastores", f.Name)
	}

	pc := property.DefaultCollector(pod.Client())

	var stores []mo.Datastore

	err = pc.Retrieve(ctx, folder.ChildEntity, []string{"info.freeSpace"}, &stores)
	if err != nil {
		return nil, err
	}

	// choose Datastore from DatastoreCluster (StoragePod) with the most free space
	var ref types.ManagedObjectReference
	var max int64

	for _, ds := range stores {
		space := ds.Info.GetDatastoreInfo().FreeSpace
		if space > max {
			max = space
			ref = ds.Reference()
		}
	}

	return object.NewDatastore(pod.Client(), ref), nil
}