github.com/vmware/govmomi@v0.51.0/cli/library/ls.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 library
     6  
     7  import (
     8  	"context"
     9  	"flag"
    10  	"fmt"
    11  	"io"
    12  
    13  	"github.com/vmware/govmomi/cli"
    14  	"github.com/vmware/govmomi/cli/flags"
    15  	"github.com/vmware/govmomi/vapi/library"
    16  	"github.com/vmware/govmomi/vapi/library/finder"
    17  )
    18  
    19  type ls struct {
    20  	*flags.ClientFlag
    21  	*flags.OutputFlag
    22  }
    23  
    24  func init() {
    25  	cli.Register("library.ls", &ls{})
    26  }
    27  
    28  func (cmd *ls) Register(ctx context.Context, f *flag.FlagSet) {
    29  	cmd.ClientFlag, ctx = flags.NewClientFlag(ctx)
    30  	cmd.OutputFlag, ctx = flags.NewOutputFlag(ctx)
    31  	cmd.ClientFlag.Register(ctx, f)
    32  	cmd.OutputFlag.Register(ctx, f)
    33  }
    34  
    35  func (cmd *ls) Process(ctx context.Context) error {
    36  	if err := cmd.ClientFlag.Process(ctx); err != nil {
    37  		return err
    38  	}
    39  	return nil
    40  }
    41  
    42  func (cmd *ls) Description() string {
    43  	return `List libraries, items, and files.
    44  
    45  Examples:
    46    govc library.ls
    47    govc library.ls /lib1
    48    govc library.ls /lib1/item1
    49    govc library.ls /lib1/item1/
    50    govc library.ls */
    51    govc library.ls -json | jq .
    52    govc library.ls /lib1/item1 -json | jq .`
    53  }
    54  
    55  type lsResultsWriter []finder.FindResult
    56  
    57  func (r lsResultsWriter) Write(w io.Writer) error {
    58  	for _, i := range r {
    59  		fmt.Fprintln(w, i.GetPath())
    60  	}
    61  	return nil
    62  }
    63  
    64  func (cmd *ls) Run(ctx context.Context, f *flag.FlagSet) error {
    65  	c, err := cmd.RestClient()
    66  	if err != nil {
    67  		return err
    68  	}
    69  
    70  	m := library.NewManager(c)
    71  	finder := finder.NewFinder(m)
    72  	findResults, err := finder.Find(ctx, f.Args()...)
    73  	if err != nil {
    74  		return err
    75  	}
    76  	return cmd.WriteResult(lsResultsWriter(findResults))
    77  }