Service - BaseImageVm

Class
VMware.Hv.BaseImageVm
See also
BaseImageVmId, BaseImageVmInfo, DatacenterId, VirtualCenterId
Since
Horizon View 6.0


Service Description

The object for fetching VMs and snapshots from VirtualCenter.

Methods

Methods defined in this Service
BaseImageVm_Get, BaseImageVm_List, BaseImageVm_ListByDatacenter

BaseImageVm_Get

Gets Base Image VM Information

Privileges

Privilege Description
VC_CONFIG_VIEW privilege is required to get BaseImageVmInfo.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the BaseImageVm used to make the method call.
idBaseImageVmId

BaseImageVmId

Return Value

Type Description
BaseImageVmInfoBaseImageVmInfo

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



BaseImageVm_List

Gets a list of all BaseImage VMs from VC which may be suitable as snapshots for linked clone desktop or farm creation. Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW privilege is required to get the list of BaseImageVmInfo.
VC_CONFIG_VIEW privilege is required to get the list of BaseImageVmInfo.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the BaseImageVm used to make the method call.
virtualCenterVirtualCenterId

unique identifier for vc entry
filterIncompatibleVmsxsd:boolean

do not return incompatible VMs which cannot be used for pool or farm creations. Default is false.

Since Horizon 7.13
  • Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type Description
BaseImageVmInfo[]Array of BaseImageVmInfo

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



BaseImageVm_ListByDatacenter

Gets a list of all BaseImage VMs from the given datacenter which may be suitable as snapshots for linked clone desktop or farm creation. Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW privilege is required to get the list of BaseImageVmInfo.
VC_CONFIG_VIEW privilege is required to get the list of BaseImageVmInfo.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the BaseImageVm used to make the method call.
datacenterDatacenterId

unique identifier for datacenter entry
filterIncompatibleVmsxsd:boolean

do not return incompatible VMs which cannot be used for pool or farm creations. Default is false.

Since Horizon 7.13
  • Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type Description
BaseImageVmInfo[]Array of BaseImageVmInfo

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition