File: info.go

package info (click to toggle)
golang-github-vmware-govmomi 0.24.2-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,848 kB
  • sloc: sh: 2,285; lisp: 1,560; ruby: 948; xml: 139; makefile: 54
file content (170 lines) | stat: -rw-r--r-- 3,435 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
Copyright (c) 2018 VMware, Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package fields

import (
	"context"
	"flag"
	"fmt"
	"io"
	"os"
	"text/tabwriter"

	"github.com/vmware/govmomi/govc/cli"
	"github.com/vmware/govmomi/govc/flags"
	"github.com/vmware/govmomi/object"
	"github.com/vmware/govmomi/property"
	"github.com/vmware/govmomi/vim25/mo"
	"github.com/vmware/govmomi/vim25/types"
)

type info struct {
	*flags.DatacenterFlag

	name string
}

func init() {
	cli.Register("fields.info", &info{})
}

func (cmd *info) Register(ctx context.Context, f *flag.FlagSet) {
	cmd.DatacenterFlag, ctx = flags.NewDatacenterFlag(ctx)
	cmd.DatacenterFlag.Register(ctx, f)

	f.StringVar(&cmd.name, "n", "", "Filter by custom field name")
}

func (cmd *info) Usage() string {
	return "PATH..."
}

func (cmd *info) Description() string {
	return `Display custom field values for PATH.

Also known as "Custom Attributes".

Examples:
  govc fields.info vm/*
  govc fields.info -n my-field-name vm/*`
}

type Info struct {
	Object types.ManagedObjectReference
	Path   string
	Name   string
	Key    string
	Value  string
}

type infoResult struct {
	Info []Info
}

func (r *infoResult) Write(w io.Writer) error {
	tw := tabwriter.NewWriter(os.Stdout, 2, 0, 2, ' ', 0)

	for _, info := range r.Info {
		_, _ = fmt.Fprintf(tw, "%s\t%s\t%s\n", info.Path, info.Key, info.Value)
	}

	return tw.Flush()
}

func (cmd *info) Run(ctx context.Context, f *flag.FlagSet) error {
	c, err := cmd.Client()
	if err != nil {
		return err
	}

	m, err := object.GetCustomFieldsManager(c)
	if err != nil {
		return err
	}

	paths := make(map[types.ManagedObjectReference]string)
	var refs []types.ManagedObjectReference

	finder, err := cmd.Finder()
	if err != nil {
		return err
	}

	for _, arg := range f.Args() {
		elements, ferr := finder.ManagedObjectList(ctx, arg)
		if ferr != nil {
			return ferr
		}

		if len(elements) == 0 {
			return fmt.Errorf("object '%s' not found", arg)
		}

		for _, e := range elements {
			ref := e.Object.Reference()
			refs = append(refs, ref)
			paths[ref] = e.Path
		}
	}

	var objs []mo.ManagedEntity
	err = property.DefaultCollector(c).Retrieve(ctx, refs, []string{"name", "customValue"}, &objs)
	if err != nil {
		return err
	}

	matches := func(key int32) bool {
		return true
	}

	if cmd.name != "" {
		fkey, cerr := m.FindKey(ctx, cmd.name)
		if cerr != nil {
			return err
		}
		matches = func(key int32) bool {
			return key == fkey
		}
	}

	field, err := m.Field(ctx)
	if err != nil {
		return err
	}

	var res infoResult

	for _, obj := range objs {
		for i := range obj.CustomValue {
			val := obj.CustomValue[i].(*types.CustomFieldStringValue)

			if !matches(val.Key) {
				continue
			}

			res.Info = append(res.Info, Info{
				Object: obj.Self,
				Path:   paths[obj.Self],
				Name:   obj.Name,
				Key:    field.ByKey(val.Key).Name,
				Value:  val.Value,
			})
		}
	}

	return cmd.WriteResult(&res)
}