github.com/vmware/govmomi@v0.51.0/cli/device/boot.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 device
     6  
     7  import (
     8  	"context"
     9  	"flag"
    10  	"strings"
    11  
    12  	"github.com/vmware/govmomi/cli"
    13  	"github.com/vmware/govmomi/cli/flags"
    14  	"github.com/vmware/govmomi/cli/vm"
    15  	"github.com/vmware/govmomi/vim25/types"
    16  )
    17  
    18  type boot struct {
    19  	*flags.VirtualMachineFlag
    20  
    21  	firmware string
    22  	order    string
    23  	types.VirtualMachineBootOptions
    24  }
    25  
    26  func init() {
    27  	cli.Register("device.boot", &boot{})
    28  }
    29  
    30  func (cmd *boot) Register(ctx context.Context, f *flag.FlagSet) {
    31  	cmd.VirtualMachineFlag, ctx = flags.NewVirtualMachineFlag(ctx)
    32  	cmd.VirtualMachineFlag.Register(ctx, f)
    33  
    34  	f.Int64Var(&cmd.BootDelay, "delay", 0, "Delay in ms before starting the boot sequence")
    35  	f.StringVar(&cmd.order, "order", "", "Boot device order [-,floppy,cdrom,ethernet,disk]")
    36  	f.Int64Var(&cmd.BootRetryDelay, "retry-delay", 0, "Delay in ms before a boot retry")
    37  
    38  	cmd.BootRetryEnabled = types.NewBool(false)
    39  	f.BoolVar(cmd.BootRetryEnabled, "retry", false, "If true, retry boot after retry-delay")
    40  
    41  	cmd.EnterBIOSSetup = types.NewBool(false)
    42  	f.BoolVar(cmd.EnterBIOSSetup, "setup", false, "If true, enter BIOS setup on next boot")
    43  
    44  	f.Var(flags.NewOptionalBool(&cmd.EfiSecureBootEnabled), "secure", "Enable EFI secure boot")
    45  	f.StringVar(&cmd.firmware, "firmware", "", vm.FirmwareUsage)
    46  }
    47  
    48  func (cmd *boot) Description() string {
    49  	return `Configure VM boot settings.
    50  
    51  Examples:
    52    govc device.boot -vm $vm -delay 1000 -order floppy,cdrom,ethernet,disk
    53    govc device.boot -vm $vm -order - # reset boot order
    54    govc device.boot -vm $vm -firmware efi -secure
    55    govc device.boot -vm $vm -firmware bios -secure=false`
    56  }
    57  
    58  func (cmd *boot) Process(ctx context.Context) error {
    59  	if err := cmd.VirtualMachineFlag.Process(ctx); err != nil {
    60  		return err
    61  	}
    62  	return nil
    63  }
    64  
    65  func (cmd *boot) Run(ctx context.Context, f *flag.FlagSet) error {
    66  	vm, err := cmd.VirtualMachine()
    67  	if err != nil {
    68  		return err
    69  	}
    70  
    71  	if vm == nil {
    72  		return flag.ErrHelp
    73  	}
    74  
    75  	devices, err := vm.Device(ctx)
    76  	if err != nil {
    77  		return err
    78  	}
    79  
    80  	if cmd.order != "" {
    81  		o := strings.Split(cmd.order, ",")
    82  		cmd.BootOrder = devices.BootOrder(o)
    83  	}
    84  
    85  	spec := types.VirtualMachineConfigSpec{
    86  		BootOptions: &cmd.VirtualMachineBootOptions,
    87  		Firmware:    cmd.firmware,
    88  	}
    89  
    90  	task, err := vm.Reconfigure(ctx, spec)
    91  	if err != nil {
    92  		return err
    93  	}
    94  
    95  	return task.Wait(ctx)
    96  }