github.com/vmware/govmomi@v0.51.0/cli/vm/guest/tools.go (about)

     1  // © Broadcom. All Rights Reserved.
     2  // The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
     3  // SPDX-License-Identifier: Apache-2.0
     4  
     5  package guest
     6  
     7  import (
     8  	"context"
     9  	"flag"
    10  
    11  	"github.com/vmware/govmomi/cli"
    12  	"github.com/vmware/govmomi/cli/flags"
    13  	"github.com/vmware/govmomi/object"
    14  )
    15  
    16  type tools struct {
    17  	*flags.ClientFlag
    18  	*flags.SearchFlag
    19  
    20  	mount   bool
    21  	upgrade bool
    22  	options string
    23  	unmount bool
    24  }
    25  
    26  func init() {
    27  	cli.Register("vm.guest.tools", &tools{})
    28  }
    29  
    30  func (cmd *tools) Register(ctx context.Context, f *flag.FlagSet) {
    31  	cmd.ClientFlag, ctx = flags.NewClientFlag(ctx)
    32  	cmd.ClientFlag.Register(ctx, f)
    33  
    34  	cmd.SearchFlag, ctx = flags.NewSearchFlag(ctx, flags.SearchVirtualMachines)
    35  	cmd.SearchFlag.Register(ctx, f)
    36  
    37  	f.BoolVar(&cmd.mount, "mount", false, "Mount tools CD installer in the guest")
    38  	f.BoolVar(&cmd.upgrade, "upgrade", false, "Upgrade tools in the guest")
    39  	f.StringVar(&cmd.options, "options", "", "Installer options")
    40  	f.BoolVar(&cmd.unmount, "unmount", false, "Unmount tools CD installer in the guest")
    41  }
    42  
    43  func (cmd *tools) Process(ctx context.Context) error {
    44  	if err := cmd.ClientFlag.Process(ctx); err != nil {
    45  		return err
    46  	}
    47  	if err := cmd.SearchFlag.Process(ctx); err != nil {
    48  		return err
    49  	}
    50  	return nil
    51  }
    52  
    53  func (cmd *tools) Usage() string {
    54  	return "VM..."
    55  }
    56  
    57  func (cmd *tools) Description() string {
    58  	return `Manage guest tools in VM.
    59  
    60  Examples:
    61    govc vm.guest.tools -mount VM
    62    govc vm.guest.tools -unmount VM
    63    govc vm.guest.tools -upgrade -options "opt1 opt2" VM`
    64  }
    65  
    66  func (cmd *tools) Upgrade(ctx context.Context, vm *object.VirtualMachine) error {
    67  	task, err := vm.UpgradeTools(ctx, cmd.options)
    68  	if err != nil {
    69  		return err
    70  	}
    71  
    72  	return task.Wait(ctx)
    73  }
    74  
    75  func (cmd *tools) Run(ctx context.Context, f *flag.FlagSet) error {
    76  	vms, err := cmd.VirtualMachines(f.Args())
    77  	if err != nil {
    78  		return err
    79  	}
    80  
    81  	for _, vm := range vms {
    82  		switch {
    83  		case cmd.mount:
    84  			err = vm.MountToolsInstaller(ctx)
    85  			if err != nil {
    86  				return err
    87  			}
    88  		case cmd.upgrade:
    89  			err = cmd.Upgrade(ctx, vm)
    90  			if err != nil {
    91  				return err
    92  			}
    93  		case cmd.unmount:
    94  			err = vm.UnmountToolsInstaller(ctx)
    95  			if err != nil {
    96  				return err
    97  			}
    98  		default:
    99  			return flag.ErrHelp
   100  		}
   101  	}
   102  
   103  	return nil
   104  }