github.com/vmware/govmomi@v0.51.0/cli/vm/dataset/create.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 dataset
     6  
     7  import (
     8  	"context"
     9  	"errors"
    10  	"flag"
    11  	"fmt"
    12  	"strings"
    13  
    14  	"github.com/vmware/govmomi/cli"
    15  	"github.com/vmware/govmomi/cli/flags"
    16  	"github.com/vmware/govmomi/vapi/vm/dataset"
    17  )
    18  
    19  var accessModes = []string{
    20  	string(dataset.AccessNone),
    21  	string(dataset.AccessReadOnly),
    22  	string(dataset.AccessReadWrite),
    23  }
    24  
    25  func hostAccessUsage() string {
    26  	return fmt.Sprintf("Access to the data set entries from the ESXi host and the vCenter (%s)", strings.Join(accessModes, "|"))
    27  }
    28  
    29  func guestAccessUsage() string {
    30  	return fmt.Sprintf("Access to the data set entries from the VM guest OS (%s)", strings.Join(accessModes, "|"))
    31  }
    32  
    33  func validateDataSetAccess(access dataset.Access) bool {
    34  	for _, validAccess := range accessModes {
    35  		if string(access) == validAccess {
    36  			return true
    37  		}
    38  	}
    39  	return false
    40  }
    41  
    42  type create struct {
    43  	*flags.VirtualMachineFlag
    44  	spec dataset.CreateSpec
    45  }
    46  
    47  func init() {
    48  	cli.Register("vm.dataset.create", &create{})
    49  }
    50  
    51  func (cmd *create) Register(ctx context.Context, f *flag.FlagSet) {
    52  	cmd.VirtualMachineFlag, ctx = flags.NewVirtualMachineFlag(ctx)
    53  	cmd.VirtualMachineFlag.Register(ctx, f)
    54  	f.StringVar(&cmd.spec.Description, "d", "", "Description")
    55  	f.StringVar((*string)(&cmd.spec.Host), "host-access", string(dataset.AccessReadWrite), hostAccessUsage())
    56  	f.StringVar((*string)(&cmd.spec.Guest), "guest-access", string(dataset.AccessReadWrite), guestAccessUsage())
    57  	f.Var(flags.NewOptionalBool(&cmd.spec.OmitFromSnapshotAndClone), "omit-from-snapshot", "Omit the data set from snapshots and clones of the VM (defaults to false)")
    58  }
    59  
    60  func (cmd *create) Process(ctx context.Context) error {
    61  	return cmd.VirtualMachineFlag.Process(ctx)
    62  }
    63  
    64  func (cmd *create) Usage() string {
    65  	return "NAME"
    66  }
    67  
    68  func (cmd *create) Description() string {
    69  	return `Create data set on a VM.
    70  
    71  This command will output the ID of the new data set.
    72  
    73  Examples:
    74    govc vm.dataset.create -vm $vm -d "Data set for project 2" -host-access READ_WRITE -guest-access READ_ONLY com.example.project2
    75    govc vm.dataset.create -vm $vm -d "Data set for project 3" -omit-from-snapshot=false com.example.project3`
    76  }
    77  
    78  func (cmd *create) Run(ctx context.Context, f *flag.FlagSet) error {
    79  	if f.NArg() != 1 {
    80  		return flag.ErrHelp
    81  	}
    82  
    83  	vm, err := cmd.VirtualMachineFlag.VirtualMachine()
    84  	if err != nil {
    85  		return err
    86  	}
    87  	if vm == nil {
    88  		return flag.ErrHelp
    89  	}
    90  	vmId := vm.Reference().Value
    91  
    92  	cmd.spec.Name = f.Arg(0)
    93  	if !validateDataSetAccess(cmd.spec.Host) {
    94  		return errors.New("please specify valid host access")
    95  	}
    96  	if !validateDataSetAccess(cmd.spec.Guest) {
    97  		return errors.New("please specify valid guest access")
    98  	}
    99  
   100  	c, err := cmd.RestClient()
   101  	if err != nil {
   102  		return err
   103  	}
   104  	mgr := dataset.NewManager(c)
   105  	id, err := mgr.CreateDataSet(ctx, vmId, &cmd.spec)
   106  	if err != nil {
   107  		return err
   108  	}
   109  	fmt.Println(id)
   110  	return nil
   111  }