view

Documentation

Index

• type ContainerView
  • func NewContainerView(c *vim25.Client, ref types.ManagedObjectReference) *ContainerView
  • func (v ContainerView) Find(ctx context.Context, kind []string, filter property.Filter) ([]types.ManagedObjectReference, error)
  • func (v ContainerView) Retrieve(ctx context.Context, kind []string, ps []string, dst interface{}) error
  • func (v ContainerView) RetrieveWithFilter(ctx context.Context, kind []string, ps []string, dst interface{}, ...) error
• type ListView
  • func NewListView(c *vim25.Client, ref types.ManagedObjectReference) *ListView
  • func (v ListView) Add(ctx context.Context, refs []types.ManagedObjectReference) error
  • func (v ListView) Remove(ctx context.Context, refs []types.ManagedObjectReference) error
  • func (v ListView) Reset(ctx context.Context, refs []types.ManagedObjectReference) error
• type ManagedObjectView
  • func NewManagedObjectView(c *vim25.Client, ref types.ManagedObjectReference) *ManagedObjectView
  • func (v *ManagedObjectView) Destroy(ctx context.Context) error
  • func (v *ManagedObjectView) TraversalSpec() *types.TraversalSpec
• type Manager
  • func NewManager(c *vim25.Client) *Manager
  • func (m Manager) CreateContainerView(ctx context.Context, container types.ManagedObjectReference, ...) (*ContainerView, error)
  • func (m Manager) CreateListView(ctx context.Context, objects []types.ManagedObjectReference) (*ListView, error)
  • func (m Manager) CreateTaskView(ctx context.Context, watch *types.ManagedObjectReference) (*TaskView, error)
• type TaskView
  • func (v TaskView) Collect(ctx context.Context, f func([]types.TaskInfo)) error

Examples

• ContainerView.Retrieve
• ContainerView.RetrieveWithFilter

Types

type ContainerView

type ContainerView struct {
	ManagedObjectView
}

func NewContainerView

func NewContainerView(c *vim25.Client, ref types.ManagedObjectReference) *ContainerView

func (ContainerView) Find

func (v ContainerView) Find(ctx context.Context, kind []string, filter property.Filter) ([]types.ManagedObjectReference, error)

Find returns object references for entities of type kind, matching the given filter.

func (ContainerView) Retrieve

func (v ContainerView) Retrieve(ctx context.Context, kind []string, ps []string, dst interface{}) error

Retrieve populates dst as property.Collector.Retrieve does, for all entities in the view of types specified by kind.

Example

Create a view of all hosts in the inventory, printing host names that belong to a cluster and excluding standalone hosts.

package main

import (
	"context"
	"fmt"
	"log"
	"sort"

	"github.com/vmware/govmomi/simulator"
	"github.com/vmware/govmomi/view"
	"github.com/vmware/govmomi/vim25"
	"github.com/vmware/govmomi/vim25/mo"
)

func main() {
	model := simulator.VPX()
	model.Datacenter = 2

	simulator.Run(func(ctx context.Context, c *vim25.Client) error {
		m := view.NewManager(c)
		kind := []string{"HostSystem"}

		v, err := m.CreateContainerView(ctx, c.ServiceContent.RootFolder, kind, true)
		if err != nil {
			log.Fatal(err)
		}

		var hosts []mo.HostSystem
		var names []string

		err = v.Retrieve(ctx, kind, []string{"summary.config.name", "parent"}, &hosts)
		if err != nil {
			return err
		}

		for _, host := range hosts {
			if host.Parent.Type != "ClusterComputeResource" {
				continue
			}
			names = append(names, host.Summary.Config.Name)
		}

		sort.Strings(names)
		fmt.Println(names)

		return v.Destroy(ctx)
	}, model)
}

Output:

[DC0_C0_H0 DC0_C0_H1 DC0_C0_H2 DC1_C0_H0 DC1_C0_H1 DC1_C0_H2]

func (ContainerView) RetrieveWithFilter

func (v ContainerView) RetrieveWithFilter(ctx context.Context, kind []string, ps []string, dst interface{}, filter property.Filter) error

RetrieveWithFilter populates dst as Retrieve does, but only for entities matching the given filter.

Example

Create a view of all VMs in the inventory, printing VM names that end with "_VM1".

package main

import (
	"context"
	"fmt"
	"log"
	"sort"

	"github.com/vmware/govmomi/property"
	"github.com/vmware/govmomi/simulator"
	"github.com/vmware/govmomi/view"
	"github.com/vmware/govmomi/vim25"
	"github.com/vmware/govmomi/vim25/mo"
)

func main() {
	simulator.Run(func(ctx context.Context, c *vim25.Client) error {
		m := view.NewManager(c)
		kind := []string{"VirtualMachine"}

		v, err := m.CreateContainerView(ctx, c.ServiceContent.RootFolder, kind, true)
		if err != nil {
			log.Fatal(err)
		}

		var vms []mo.VirtualMachine
		var names []string

		err = v.RetrieveWithFilter(ctx, kind, []string{"name"}, &vms, property.Filter{"name": "*_VM1"})
		if err != nil {
			return err
		}

		for _, vm := range vms {
			names = append(names, vm.Name)
		}

		sort.Strings(names)
		fmt.Println(names)

		return v.Destroy(ctx)
	})
}

Output:

[DC0_C0_RP0_VM1 DC0_H0_VM1]

type ListView

type ListView struct {
	ManagedObjectView
}

func NewListView

func NewListView(c *vim25.Client, ref types.ManagedObjectReference) *ListView

func (ListView) Add

func (v ListView) Add(ctx context.Context, refs []types.ManagedObjectReference) error

func (ListView) Remove

func (v ListView) Remove(ctx context.Context, refs []types.ManagedObjectReference) error

func (ListView) Reset

func (v ListView) Reset(ctx context.Context, refs []types.ManagedObjectReference) error

type ManagedObjectView

type ManagedObjectView struct {
	object.Common
}

func NewManagedObjectView

func NewManagedObjectView(c *vim25.Client, ref types.ManagedObjectReference) *ManagedObjectView

func (*ManagedObjectView) Destroy

func (v *ManagedObjectView) Destroy(ctx context.Context) error

func (*ManagedObjectView) TraversalSpec

func (v *ManagedObjectView) TraversalSpec() *types.TraversalSpec

type Manager

type Manager struct {
	object.Common
}

func NewManager

func NewManager(c *vim25.Client) *Manager

func (Manager) CreateContainerView

func (m Manager) CreateContainerView(ctx context.Context, container types.ManagedObjectReference, managedObjectTypes []string, recursive bool) (*ContainerView, error)

func (Manager) CreateListView

func (m Manager) CreateListView(ctx context.Context, objects []types.ManagedObjectReference) (*ListView, error)

func (Manager) CreateTaskView

func (m Manager) CreateTaskView(ctx context.Context, watch *types.ManagedObjectReference) (*TaskView, error)

CreateTaskView creates a new ListView that optionally watches for a ManagedEntity's recentTask updates.

type TaskView

type TaskView struct {
	*ListView

	Follow bool

	Watch *types.ManagedObjectReference
}

TaskView extends ListView such that it can follow a ManagedEntity's recentTask updates.

func (TaskView) Collect

func (v TaskView) Collect(ctx context.Context, f func([]types.TaskInfo)) error

Collect calls function f for each Task update.