Managed Object - EnvironmentBrowser

Property of
ComputeResource, VirtualMachine
See also
ConfigTarget, HostDatastoreBrowser, HostSystem, VirtualMachineConfigOption, VirtualMachineConfigOptionDescriptor

Managed Object Description

This managed object type provides access to the environment that a ComputeResource presents for creating and configuring a virtual machine.

The environment consists of three main components:

Properties

Name Type Description
datastoreBrowser* PManagedObjectReference
to a HostDatastoreBrowser
DatastoreBrowser to browse datastores that are available on this entity.
*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
QueryConfigOption, QueryConfigOptionDescriptor, QueryConfigTarget

QueryConfigOption

Query for a specific virtual machine configuration option (the ConfigOption). A single query may include either "key" or "host", but not both. If "key" is passed, then the ConfigOption corresponding to that key value is returned. If "host" is passed, then the default ConfigOption for that host is returned. If neither is passed, then the default ConfigOption for this environment browser is returned. Typically, the default contains the options for the most recent virtual hardware supported.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EnvironmentBrowser used to make the method call.
key*xsd:string The key found in the VirtualMachineConfigOptionDescriptor, obtained by invoking the vim.environmentbrowser.queryConfigOptionDescriptor operation.
host*ManagedObjectReference
to a HostSystem
The host whose default ConfigOption is requested.
*Need not be set

Return Value

Type Description
VirtualMachineConfigOptionReturns the ConfigOption object. If invoked on a cluster with no hosts, null is returned.

Faults

Type Description
InvalidArgumentThrown if any of the following is true:
  • Both key and host are passed.
  • An invalid key is passed.
  • An invalid host is passed.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryConfigOptionDescriptor

The list of ConfigOption keys available on this entity.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EnvironmentBrowser used to make the method call.

Return Value

Type Description
VirtualMachineConfigOptionDescriptor[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryConfigTarget

Queries for information about a specific target, a "physical" device that can be used to back virtual devices. The ConfigTarget that is returned specifies the set of values that can be used in the device backings to connect the virtual machine to physical (or logical) host devices.

If the EnvironmentBrowser is from a ClusterComputeResource, the host argument can be used to return the ConfigTarget provided by a particular host in the cluster.

If no host is passed in and the EnvironmentBrowser is from a ClusterComputeResource, then the vim.vm.TargetInfo.configurationTag field indicates how widely the device is available across the cluster.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EnvironmentBrowser used to make the method call.
host*ManagedObjectReference
to a HostSystem
If specified, the host whose default BackingInfo is requested.
*Need not be set

Return Value

Type Description
ConfigTargetReturns the ConfigTarget object. If invoked on a cluster with no hosts, null is returned.

Faults

Type Description
InvalidArgumentThrown if an invalid host is passed in.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition