Scripting Object - VcEnvironmentBrowser

Scripting-object corresponding to
EnvironmentBrowser
Attribute of
VcClusterComputeResource, VcComputeResource, VcVirtualMachine

Scripting 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:

Attributes

Name Type Description
datastoreBrowserVcHostDatastoreBrowser

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, queryConfigOption, queryConfigOptionDescriptor, queryConfigOptionEx, queryConfigTarget, queryConfigTargetSpec, queryProvisioningPolicy, queryTargetCapabilities

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

queryConfigOptionDescriptor

The list of ConfigOption keys available on this entity. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcVirtualMachineConfigOptionDescriptor []

queryConfigOptionEx

Query for a virtual machine configuration {@link vim.vm.ConfigOption option} matching the key or host or both given in the {@link vim.EnvironmentBrowser.ConfigOptionQuerySpec}. For more details see {@link vim.EnvironmentBrowser#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 {@link vim.vm.ConfigOption#guestOSDescriptor guestOSDescriptor} list contains only the guestId of the virutal machine. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcEnvironmentBrowserConfigOptionQuerySpec


Return Value

Type Description
VcVirtualMachineConfigOption

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostSystem


Return Value

Type Description
VcConfigTarget

queryProvisioningPolicy

Query for information about the virtual machine provisioning operation policy.

This method is not supported if the EnvironmentBrowser is from a VirtualMachine. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostSystem


Return Value

Type Description
VcVirtualMachineProvisioningPolicy

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostSystem


Return Value

Type Description
VcVirtualMachineConfigOption

queryConfigTargetSpec

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. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcHostSystem

arg1VcEnvironmentBrowserConfigTargetQuerySpec


Return Value

Type Description
VcConfigTarget

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. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostSystem


Return Value

Type Description
VcHostCapability