find

Documentation

Overview

Package find implements inventory listing and searching.

The Finder is an alternative to the object.SearchIndex FindByInventoryPath() and FindChild() methods. SearchIndex.FindByInventoryPath requires an absolute path, whereas the Finder also supports relative paths and patterns via path.Match. SearchIndex.FindChild requires a parent to find the child, whereas the Finder also supports an ancestor via recursive object traversal.

The various Finder methods accept a "path" argument, which can absolute or relative to the Folder for the object type. The Finder supports two modes, "list" and "find". The "list" mode behaves like the "ls" command, only searching within the immediate path. The "find" mode behaves like the "find" command, with the search starting at the immediate path but also recursing into sub Folders relative to the Datacenter. The default mode is "list" if the given path contains a "/", otherwise "find" mode is used.

The exception is to use a "..." wildcard with a path to find all objects recursively underneath any root object. For example: VirtualMachineList("/DC1/...")

See also: https://github.com/vmware/govmomi/blob/master/govc/README.md#usage

Index

• type DefaultMultipleFoundError
  • func (e DefaultMultipleFoundError) Error() string
• type DefaultNotFoundError
  • func (e *DefaultNotFoundError) Error() string
• type Finder
  • func NewFinder(client *vim25.Client, all bool) *Finder
  • func (f *Finder) ClusterComputeResource(ctx context.Context, path string) (*object.ClusterComputeResource, error)
  • func (f *Finder) ClusterComputeResourceList(ctx context.Context, path string) ([]*object.ClusterComputeResource, error)
  • func (f *Finder) ClusterComputeResourceOrDefault(ctx context.Context, path string) (*object.ClusterComputeResource, error)
  • func (f *Finder) ComputeResource(ctx context.Context, path string) (*object.ComputeResource, error)
  • func (f *Finder) ComputeResourceList(ctx context.Context, path string) ([]*object.ComputeResource, error)
  • func (f *Finder) ComputeResourceOrDefault(ctx context.Context, path string) (*object.ComputeResource, error)
  • func (f *Finder) Datacenter(ctx context.Context, path string) (*object.Datacenter, error)
  • func (f *Finder) DatacenterList(ctx context.Context, path string) ([]*object.Datacenter, error)
  • func (f *Finder) DatacenterOrDefault(ctx context.Context, path string) (*object.Datacenter, error)
  • func (f *Finder) Datastore(ctx context.Context, path string) (*object.Datastore, error)
  • func (f *Finder) DatastoreCluster(ctx context.Context, path string) (*object.StoragePod, error)
  • func (f *Finder) DatastoreClusterList(ctx context.Context, path string) ([]*object.StoragePod, error)
  • func (f *Finder) DatastoreClusterOrDefault(ctx context.Context, path string) (*object.StoragePod, error)
  • func (f *Finder) DatastoreList(ctx context.Context, path string) ([]*object.Datastore, error)
  • func (f *Finder) DatastoreOrDefault(ctx context.Context, path string) (*object.Datastore, error)
  • func (f *Finder) DefaultClusterComputeResource(ctx context.Context) (*object.ClusterComputeResource, error)
  • func (f *Finder) DefaultComputeResource(ctx context.Context) (*object.ComputeResource, error)
  • func (f *Finder) DefaultDatacenter(ctx context.Context) (*object.Datacenter, error)
  • func (f *Finder) DefaultDatastore(ctx context.Context) (*object.Datastore, error)
  • func (f *Finder) DefaultDatastoreCluster(ctx context.Context) (*object.StoragePod, error)
  • func (f *Finder) DefaultFolder(ctx context.Context) (*object.Folder, error)
  • func (f *Finder) DefaultHostSystem(ctx context.Context) (*object.HostSystem, error)
  • func (f *Finder) DefaultNetwork(ctx context.Context) (object.NetworkReference, error)
  • func (f *Finder) DefaultResourcePool(ctx context.Context) (*object.ResourcePool, error)
  • func (f *Finder) Element(ctx context.Context, ref types.ManagedObjectReference) (*list.Element, error)
  • func (f *Finder) Folder(ctx context.Context, path string) (*object.Folder, error)
  • func (f *Finder) FolderList(ctx context.Context, path string) ([]*object.Folder, error)
  • func (f *Finder) FolderOrDefault(ctx context.Context, path string) (*object.Folder, error)
  • func (f *Finder) HostSystem(ctx context.Context, path string) (*object.HostSystem, error)
  • func (f *Finder) HostSystemList(ctx context.Context, path string) ([]*object.HostSystem, error)
  • func (f *Finder) HostSystemOrDefault(ctx context.Context, path string) (*object.HostSystem, error)
  • func (f *Finder) ManagedObjectList(ctx context.Context, path string, include ...string) ([]list.Element, error)
  • func (f *Finder) ManagedObjectListChildren(ctx context.Context, path string, include ...string) ([]list.Element, error)
  • func (f *Finder) Network(ctx context.Context, path string) (object.NetworkReference, error)
  • func (f *Finder) NetworkList(ctx context.Context, path string) ([]object.NetworkReference, error)
  • func (f *Finder) NetworkOrDefault(ctx context.Context, path string) (object.NetworkReference, error)
  • func (f *Finder) ObjectReference(ctx context.Context, ref types.ManagedObjectReference) (object.Reference, error)
  • func (f *Finder) ResourcePool(ctx context.Context, path string) (*object.ResourcePool, error)
  • func (f *Finder) ResourcePoolList(ctx context.Context, path string) ([]*object.ResourcePool, error)
  • func (f *Finder) ResourcePoolListAll(ctx context.Context, path string) ([]*object.ResourcePool, error)
  • func (f *Finder) ResourcePoolOrDefault(ctx context.Context, path string) (*object.ResourcePool, error)
  • func (f *Finder) SetDatacenter(dc *object.Datacenter) *Finder
  • func (f *Finder) VirtualApp(ctx context.Context, path string) (*object.VirtualApp, error)
  • func (f *Finder) VirtualAppList(ctx context.Context, path string) ([]*object.VirtualApp, error)
  • func (f *Finder) VirtualMachine(ctx context.Context, path string) (*object.VirtualMachine, error)
  • func (f *Finder) VirtualMachineList(ctx context.Context, path string) ([]*object.VirtualMachine, error)
• type MultipleFoundError
  • func (e *MultipleFoundError) Error() string
• type NotFoundError
  • func (e *NotFoundError) Error() string

Types

type DefaultMultipleFoundError

type DefaultMultipleFoundError struct {
	// contains filtered or unexported fields
}

func (DefaultMultipleFoundError) Error

func (e DefaultMultipleFoundError) Error() string

type DefaultNotFoundError

type DefaultNotFoundError struct {
	// contains filtered or unexported fields
}

func (*DefaultNotFoundError) Error

func (e *DefaultNotFoundError) Error() string

type Finder

type Finder struct {
	// contains filtered or unexported fields
}

func NewFinder

func NewFinder(client *vim25.Client, all bool) *Finder

func (*Finder) ClusterComputeResource

func (f *Finder) ClusterComputeResource(ctx context.Context, path string) (*object.ClusterComputeResource, error)

func (*Finder) ClusterComputeResourceList

func (f *Finder) ClusterComputeResourceList(ctx context.Context, path string) ([]*object.ClusterComputeResource, error)

func (*Finder) ClusterComputeResourceOrDefault

func (f *Finder) ClusterComputeResourceOrDefault(ctx context.Context, path string) (*object.ClusterComputeResource, error)

func (*Finder) ComputeResource

func (f *Finder) ComputeResource(ctx context.Context, path string) (*object.ComputeResource, error)

func (*Finder) ComputeResourceList

func (f *Finder) ComputeResourceList(ctx context.Context, path string) ([]*object.ComputeResource, error)

func (*Finder) ComputeResourceOrDefault

func (f *Finder) ComputeResourceOrDefault(ctx context.Context, path string) (*object.ComputeResource, error)

func (*Finder) Datacenter

func (f *Finder) Datacenter(ctx context.Context, path string) (*object.Datacenter, error)

func (*Finder) DatacenterList

func (f *Finder) DatacenterList(ctx context.Context, path string) ([]*object.Datacenter, error)

func (*Finder) DatacenterOrDefault

func (f *Finder) DatacenterOrDefault(ctx context.Context, path string) (*object.Datacenter, error)

func (*Finder) Datastore

func (f *Finder) Datastore(ctx context.Context, path string) (*object.Datastore, error)

func (*Finder) DatastoreCluster

func (f *Finder) DatastoreCluster(ctx context.Context, path string) (*object.StoragePod, error)

func (*Finder) DatastoreClusterList

func (f *Finder) DatastoreClusterList(ctx context.Context, path string) ([]*object.StoragePod, error)

func (*Finder) DatastoreClusterOrDefault

func (f *Finder) DatastoreClusterOrDefault(ctx context.Context, path string) (*object.StoragePod, error)

func (*Finder) DatastoreList

func (f *Finder) DatastoreList(ctx context.Context, path string) ([]*object.Datastore, error)

func (*Finder) DatastoreOrDefault

func (f *Finder) DatastoreOrDefault(ctx context.Context, path string) (*object.Datastore, error)

func (*Finder) DefaultClusterComputeResource

func (f *Finder) DefaultClusterComputeResource(ctx context.Context) (*object.ClusterComputeResource, error)

func (*Finder) DefaultComputeResource

func (f *Finder) DefaultComputeResource(ctx context.Context) (*object.ComputeResource, error)

func (*Finder) DefaultDatacenter

func (f *Finder) DefaultDatacenter(ctx context.Context) (*object.Datacenter, error)

func (*Finder) DefaultDatastore

func (f *Finder) DefaultDatastore(ctx context.Context) (*object.Datastore, error)

func (*Finder) DefaultDatastoreCluster

func (f *Finder) DefaultDatastoreCluster(ctx context.Context) (*object.StoragePod, error)

func (*Finder) DefaultFolder

func (f *Finder) DefaultFolder(ctx context.Context) (*object.Folder, error)

func (*Finder) DefaultHostSystem

func (f *Finder) DefaultHostSystem(ctx context.Context) (*object.HostSystem, error)

func (*Finder) DefaultNetwork

func (f *Finder) DefaultNetwork(ctx context.Context) (object.NetworkReference, error)

func (*Finder) DefaultResourcePool

func (f *Finder) DefaultResourcePool(ctx context.Context) (*object.ResourcePool, error)

func (*Finder) Element

func (f *Finder) Element(ctx context.Context, ref types.ManagedObjectReference) (*list.Element, error)

Element returns an Element for the given ManagedObjectReference This method is only useful for looking up the InventoryPath of a ManagedObjectReference.

func (*Finder) Folder

func (f *Finder) Folder(ctx context.Context, path string) (*object.Folder, error)

func (*Finder) FolderList

func (f *Finder) FolderList(ctx context.Context, path string) ([]*object.Folder, error)

func (*Finder) FolderOrDefault

func (f *Finder) FolderOrDefault(ctx context.Context, path string) (*object.Folder, error)

func (*Finder) HostSystem

func (f *Finder) HostSystem(ctx context.Context, path string) (*object.HostSystem, error)

func (*Finder) HostSystemList

func (f *Finder) HostSystemList(ctx context.Context, path string) ([]*object.HostSystem, error)

func (*Finder) HostSystemOrDefault

func (f *Finder) HostSystemOrDefault(ctx context.Context, path string) (*object.HostSystem, error)

func (*Finder) ManagedObjectList

func (f *Finder) ManagedObjectList(ctx context.Context, path string, include ...string) ([]list.Element, error)

func (*Finder) ManagedObjectListChildren

func (f *Finder) ManagedObjectListChildren(ctx context.Context, path string, include ...string) ([]list.Element, error)

func (*Finder) Network

func (f *Finder) Network(ctx context.Context, path string) (object.NetworkReference, error)

func (*Finder) NetworkList

func (f *Finder) NetworkList(ctx context.Context, path string) ([]object.NetworkReference, error)

func (*Finder) NetworkOrDefault

func (f *Finder) NetworkOrDefault(ctx context.Context, path string) (object.NetworkReference, error)

func (*Finder) ObjectReference

func (f *Finder) ObjectReference(ctx context.Context, ref types.ManagedObjectReference) (object.Reference, error)

ObjectReference converts the given ManagedObjectReference to a type from the object package via object.NewReference with the object.Common.InventoryPath field set.

func (*Finder) ResourcePool

func (f *Finder) ResourcePool(ctx context.Context, path string) (*object.ResourcePool, error)

func (*Finder) ResourcePoolList

func (f *Finder) ResourcePoolList(ctx context.Context, path string) ([]*object.ResourcePool, error)

func (*Finder) ResourcePoolListAll

func (f *Finder) ResourcePoolListAll(ctx context.Context, path string) ([]*object.ResourcePool, error)

ResourcePoolListAll combines ResourcePoolList and VirtualAppList VirtualAppList is only called if ResourcePoolList does not find any pools with the given path.

func (*Finder) ResourcePoolOrDefault

func (f *Finder) ResourcePoolOrDefault(ctx context.Context, path string) (*object.ResourcePool, error)

func (*Finder) SetDatacenter

func (f *Finder) SetDatacenter(dc *object.Datacenter) *Finder

func (*Finder) VirtualApp

func (f *Finder) VirtualApp(ctx context.Context, path string) (*object.VirtualApp, error)

func (*Finder) VirtualAppList

func (f *Finder) VirtualAppList(ctx context.Context, path string) ([]*object.VirtualApp, error)

func (*Finder) VirtualMachine

func (f *Finder) VirtualMachine(ctx context.Context, path string) (*object.VirtualMachine, error)

func (*Finder) VirtualMachineList

func (f *Finder) VirtualMachineList(ctx context.Context, path string) ([]*object.VirtualMachine, error)

type MultipleFoundError

type MultipleFoundError struct {
	// contains filtered or unexported fields
}

func (*MultipleFoundError) Error

func (e *MultipleFoundError) Error() string

type NotFoundError

type NotFoundError struct {
	// contains filtered or unexported fields
}

func (*NotFoundError) Error

func (e *NotFoundError) Error() string