github.com/vmware/govmomi@v0.43.0/govc/cluster/module/ls.go (about)

     1  /*
     2  Copyright (c) 2022 VMware, Inc. All Rights Reserved.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package module
    18  
    19  import (
    20  	"context"
    21  	"flag"
    22  	"fmt"
    23  	"io"
    24  	"text/tabwriter"
    25  
    26  	"github.com/vmware/govmomi/govc/cli"
    27  	"github.com/vmware/govmomi/govc/flags"
    28  	"github.com/vmware/govmomi/vapi/cluster"
    29  	"github.com/vmware/govmomi/vim25/types"
    30  )
    31  
    32  type ls struct {
    33  	*flags.ClientFlag
    34  	*flags.OutputFlag
    35  	moduleID string
    36  }
    37  
    38  func init() {
    39  	cli.Register("cluster.module.ls", &ls{})
    40  }
    41  
    42  func (cmd *ls) Register(ctx context.Context, f *flag.FlagSet) {
    43  	cmd.ClientFlag, ctx = flags.NewClientFlag(ctx)
    44  	cmd.ClientFlag.Register(ctx, f)
    45  
    46  	cmd.OutputFlag, ctx = flags.NewOutputFlag(ctx)
    47  	cmd.OutputFlag.Register(ctx, f)
    48  
    49  	f.StringVar(&cmd.moduleID, "id", "", "Module ID")
    50  }
    51  
    52  func (cmd *ls) Process(ctx context.Context) error {
    53  	return cmd.ClientFlag.Process(ctx)
    54  }
    55  
    56  func (cmd *ls) Description() string {
    57  	return `List cluster modules.
    58  
    59  When -id is specified, that module's members are listed.
    60  
    61  Examples:
    62    govc cluster.module.ls
    63    govc cluster.module.ls -json | jq .
    64    govc cluster.module.ls -id module_id`
    65  }
    66  
    67  type lsResult []cluster.ModuleSummary
    68  
    69  func (r lsResult) Write(w io.Writer) error {
    70  	tw := tabwriter.NewWriter(w, 2, 0, 2, ' ', 0)
    71  
    72  	for _, i := range r {
    73  		fmt.Fprintf(tw, "%s\t%s\n", i.Cluster, i.Module)
    74  	}
    75  
    76  	return tw.Flush()
    77  }
    78  
    79  func (cmd *ls) List(ctx context.Context, m *cluster.Manager) error {
    80  	var res lsResult
    81  
    82  	res, err := m.ListModules(ctx)
    83  	if err != nil {
    84  		return err
    85  	}
    86  
    87  	return cmd.WriteResult(res)
    88  }
    89  
    90  type lsMemberResult []types.ManagedObjectReference
    91  
    92  func (r lsMemberResult) Write(w io.Writer) error {
    93  	tw := tabwriter.NewWriter(w, 2, 0, 2, ' ', 0)
    94  
    95  	for _, i := range r {
    96  		fmt.Fprintf(tw, "%s\t%s\n", i.Reference().Type, i.Reference().Value)
    97  	}
    98  
    99  	return tw.Flush()
   100  }
   101  
   102  func (cmd *ls) ListMembers(ctx context.Context, m *cluster.Manager, moduleID string) error {
   103  	var res lsMemberResult
   104  
   105  	res, err := m.ListModuleMembers(ctx, moduleID)
   106  	if err != nil {
   107  		return err
   108  	}
   109  
   110  	return cmd.WriteResult(res)
   111  }
   112  
   113  func (cmd *ls) Run(ctx context.Context, f *flag.FlagSet) error {
   114  	if f.NArg() != 0 {
   115  		return flag.ErrHelp
   116  	}
   117  
   118  	c, err := cmd.RestClient()
   119  	if err != nil {
   120  		return err
   121  	}
   122  
   123  	m := cluster.NewManager(c)
   124  
   125  	if cmd.moduleID == "" {
   126  		return cmd.List(ctx, m)
   127  	}
   128  
   129  	return cmd.ListMembers(ctx, m, cmd.moduleID)
   130  }