github.com/minio/mc@v0.0.0-20240503112107-b471de8d1882/cmd/admin-group-list.go (about)

     1  // Copyright (c) 2015-2022 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package cmd
    19  
    20  import (
    21  	"github.com/fatih/color"
    22  	"github.com/minio/cli"
    23  	"github.com/minio/mc/pkg/probe"
    24  	"github.com/minio/pkg/v2/console"
    25  )
    26  
    27  var adminGroupListCmd = cli.Command{
    28  	Name:         "list",
    29  	ShortName:    "ls",
    30  	Usage:        "display list of groups",
    31  	Action:       mainAdminGroupList,
    32  	OnUsageError: onUsageError,
    33  	Before:       setGlobalsFromContext,
    34  	Flags:        globalFlags,
    35  	CustomHelpTemplate: `NAME:
    36    {{.HelpName}} - {{.Usage}}
    37  
    38  USAGE:
    39    {{.HelpName}} TARGET
    40  
    41  FLAGS:
    42    {{range .VisibleFlags}}{{.}}
    43    {{end}}
    44  EXAMPLES:
    45    1. List all groups.
    46       {{.Prompt}} {{.HelpName}} myminio
    47  `,
    48  }
    49  
    50  // checkAdminGroupListSyntax - validate all the passed arguments
    51  func checkAdminGroupListSyntax(ctx *cli.Context) {
    52  	if len(ctx.Args()) != 1 {
    53  		showCommandHelpAndExit(ctx, 1) // last argument is exit code
    54  	}
    55  }
    56  
    57  // mainAdminGroupList is the handle for "mc admin group list" command.
    58  func mainAdminGroupList(ctx *cli.Context) error {
    59  	checkAdminGroupListSyntax(ctx)
    60  
    61  	console.SetColor("GroupMessage", color.New(color.FgGreen))
    62  
    63  	// Get the alias parameter from cli
    64  	args := ctx.Args()
    65  	aliasedURL := args.Get(0)
    66  
    67  	// Create a new MinIO Admin Client
    68  	client, err := newAdminClient(aliasedURL)
    69  	fatalIf(err, "Unable to initialize admin connection.")
    70  
    71  	gs, e := client.ListGroups(globalContext)
    72  	fatalIf(probe.NewError(e).Trace(args...), "Unable to list groups")
    73  
    74  	printMsg(groupMessage{
    75  		op:     ctx.Command.Name,
    76  		Groups: gs,
    77  	})
    78  
    79  	return nil
    80  }