github.com/vmware/govmomi@v0.51.0/cli/datastore/maintenance/enter.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 maintenance
     6  
     7  import (
     8  	"context"
     9  	"flag"
    10  	"fmt"
    11  
    12  	"github.com/vmware/govmomi/cli"
    13  	"github.com/vmware/govmomi/cli/flags"
    14  	"github.com/vmware/govmomi/object"
    15  	"github.com/vmware/govmomi/vim25/methods"
    16  	"github.com/vmware/govmomi/vim25/types"
    17  )
    18  
    19  type enter struct {
    20  	*flags.DatastoreFlag
    21  }
    22  
    23  func init() {
    24  	cli.Register("datastore.maintenance.enter", &enter{})
    25  }
    26  
    27  func (cmd *enter) Register(ctx context.Context, f *flag.FlagSet) {
    28  	cmd.DatastoreFlag, ctx = flags.NewDatastoreFlag(ctx)
    29  	cmd.DatastoreFlag.Register(ctx, f)
    30  }
    31  
    32  func (cmd *enter) Usage() string {
    33  	return "DATASTORE"
    34  }
    35  
    36  func (cmd *enter) Description() string {
    37  	return `Put DATASTORE in maintenance mode.
    38  
    39  Examples:
    40    govc datastore.cluster.change -drs-mode automated my-datastore-cluster # automatically schedule Storage DRS migration
    41    govc datastore.maintenance.enter -ds my-datastore-cluster/datastore1
    42    # no virtual machines can be powered on and no provisioning operations can be performed on the datastore during this time
    43    govc datastore.maintenance.exit -ds my-datastore-cluster/datastore1`
    44  }
    45  
    46  func (cmd *enter) EnterMaintenanceMode(ctx context.Context, ds *object.Datastore) error {
    47  	req := &types.DatastoreEnterMaintenanceMode{
    48  		This: ds.Reference(),
    49  	}
    50  	res, err := methods.DatastoreEnterMaintenanceMode(ctx, ds.Client(), req)
    51  	if err != nil {
    52  		return err
    53  	}
    54  
    55  	logger := cmd.ProgressLogger(fmt.Sprintf("%s entering maintenance mode... ", ds.InventoryPath))
    56  	defer logger.Wait()
    57  
    58  	task := object.NewTask(ds.Client(), *res.Returnval.Task)
    59  	_, err = task.WaitForResult(ctx, logger)
    60  	return err
    61  }
    62  
    63  func (cmd *enter) Run(ctx context.Context, f *flag.FlagSet) error {
    64  	ds, err := cmd.Datastore()
    65  	if err != nil {
    66  		return err
    67  	}
    68  
    69  	return cmd.EnterMaintenanceMode(ctx, ds)
    70  }