github.com/vmware/govmomi@v0.37.1/govc/fields/add.go (about)

     1  /*
     2  Copyright (c) 2015 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 fields
    18  
    19  import (
    20  	"context"
    21  	"flag"
    22  	"fmt"
    23  
    24  	"github.com/vmware/govmomi/govc/cli"
    25  	"github.com/vmware/govmomi/govc/flags"
    26  	"github.com/vmware/govmomi/object"
    27  )
    28  
    29  type add struct {
    30  	*flags.ClientFlag
    31  	kind string
    32  }
    33  
    34  func init() {
    35  	cli.Register("fields.add", &add{})
    36  }
    37  
    38  func (cmd *add) Register(ctx context.Context, f *flag.FlagSet) {
    39  	cmd.ClientFlag, ctx = flags.NewClientFlag(ctx)
    40  	cmd.ClientFlag.Register(ctx, f)
    41  
    42  	f.StringVar(&cmd.kind, "type", "", "Managed object type")
    43  }
    44  
    45  func (cmd *add) Usage() string {
    46  	return "NAME"
    47  }
    48  
    49  func (cmd *add) Description() string {
    50  	return `Add a custom field type with NAME.
    51  
    52  Examples:
    53    govc fields.add my-field-name # adds a field to all managed object types
    54    govc fields.add -type VirtualMachine my-vm-field-name # adds a field to the VirtualMachine type`
    55  }
    56  
    57  func (cmd *add) Run(ctx context.Context, f *flag.FlagSet) error {
    58  	if f.NArg() != 1 {
    59  		return flag.ErrHelp
    60  	}
    61  
    62  	c, err := cmd.Client()
    63  	if err != nil {
    64  		return err
    65  	}
    66  
    67  	m, err := object.GetCustomFieldsManager(c)
    68  	if err != nil {
    69  		return err
    70  	}
    71  
    72  	name := f.Arg(0)
    73  
    74  	def, err := m.Add(ctx, name, cmd.kind, nil, nil)
    75  	if err != nil {
    76  		return err
    77  	}
    78  
    79  	fmt.Printf("%d\n", def.Key)
    80  
    81  	return nil
    82  }