Managed Object - EnvironmentBrowser(vim.EnvironmentBrowser)

Property of
ComputeResource, VirtualMachine
See also
ConfigTarget, EnvironmentBrowserConfigOptionQuerySpec, HostCapability, 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, QueryConfigOptionEx, QueryConfigTarget, QueryTargetCapabilities

QueryConfigOption(queryConfigOption)

Query for a specific virtual machine configuration option (the ConfigOption).

If the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, the key or host, or both arguments can be used to return the required config options. If a key is specified, then the ConfigOption corresponding to that key value is returned. If a host is specified, then the default ConfigOption for that host is returned. If key and host both are specified, the ConfigOption corresponding to the given key for that host is returned. If neither is specified, then the default ConfigOption for this environment browser is returned. Typically, the default contains the options for the most recent virtual hardware supported.

If the EnvironmentBrowser is from a VirtualMachine neither a host nor a key should be specified.

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 QueryConfigOptionDescriptor operation.
host*ManagedObjectReference
to a HostSystem

The host whose ConfigOption is requested.
*Need not be set

Return Value

Type Description
VirtualMachineConfigOptionReturns the ConfigOption object. If invoked on a cluster with no hosts, or if the ConfigOption with given key is not found for the given host, null is returned.

Faults

Type Description
InvalidArgumentThrown if any of the following is true:
  • An invalid key is passed.
  • An invalid host is passed.
  • A key or host is specified, when the command is invoked from the environment browser of a virtual machine.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryConfigOptionDescriptor(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.

Events

Type
None

Show WSDL type definition



QueryConfigOptionEx(queryConfigOptionEx)

Query for a virtual machine configuration option matching the key or host or both given in the EnvironmentBrowserConfigOptionQuerySpec. For more details see QueryConfigOption

If the Environment Browser belongs to a virtual machine and the spec argument is omitted, the method returns the ConfigOption object corresponding to the vmx version of the virutal machine and the guestOSDescriptor list contains only the guestId of the virutal machine.

Required Privileges
System.View
Since
vSphere API 6.0

Parameters

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

Search criteria and filters to control the result. If a key or host (or both) are specified, they will be used to search for a config option. If guestId is nonempty, the guestOSDescriptor array of the config option is filtered to match against the guest IDs in the spec. If there is no match, the whole list is returned. If the spec argument is omitted, the default VirtualMachineConfigOption for this environment browser is returned.
*Need not be set

Return Value

Type Description
VirtualMachineConfigOptionReturns the VirtualMachineConfigOption object. If invoked on a cluster with no hosts, or if the VirtualMachineConfigOption with given key is not found for the given host, null is returned.

Faults

Type Description
InvalidArgumentThrown if any of the following is true:
  • An invalid key is passed.
  • An invalid host is passed.
  • A host is specified, when the command is invoked from the environment browser of a virtual machine.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryConfigTarget(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 ComputeResource or ClusterComputeResource, the host argument can be used to return the ConfigTarget provided by a particular host in the compute resource or cluster. If host is not specified and the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, then the union of all the devices is returned and the vim.vm.TargetInfo.configurationTag field indicates how widely the device is available across the compute resource or cluster.

If the EnvironmentBrowser is from a VirtualMachine a host should not be specified.

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 specified , or a host is given when the EnvironmentBrowser is from a virtual machine.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryTargetCapabilities(queryTargetCapabilities)

Queries for information on the capabilities supported by the ComputeResource associated with the EnvironmentBrowser.

If the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, the host argument can be used to return the capabilities associated with a specific host in the compute resource or cluster. If the host argument is not specified and the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, then the intersection of the capabilities supported by all the hosts in the cluster is returned. If the EnvironmentBrowser is from a VirtualMachine, the compute resource associated with the virtual machine will be queried for its capabilities.

If the EnvironmentBrowser is from a VirtualMachine a host should not be specified.

Required Privileges
System.View
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EnvironmentBrowser used to make the method call.
host*ManagedObjectReference
to a HostSystem

If specified, the host whose capabilities are requested.
*Need not be set

Return Value

Type Description
HostCapabilityReturns the set of capabilities supported by the ComputeResource associated with the EnvironmentBrowser. If invoked on a cluster with no hosts, null is returned.

Faults

Type Description
InvalidArgumentThrown if an invalid host is specified , or a host is given when the EnvironmentBrowser is from a virtual machine.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition