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

Name	Type	Description
_this	ManagedObjectReference	A reference to the BaseImageVm used to make the method call.
id	BaseImageVmId	BaseImageVmId

Return Value

Type	Description
BaseImageVmInfo	BaseImageVmInfo

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="BaseImageVm_Get" type="vdi:BaseImageVm_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="BaseImageVm_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:BaseImageVmInfo"/>
               </sequence>
            </complexType>
         </element>

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

Name

Type

Description

_this

ManagedObjectReference

A reference to the BaseImageVm used to make the method call.

virtualCenter

VirtualCenterId

unique identifier for vc entry

filterIncompatibleVms

xsd: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
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="BaseImageVm_List" type="vdi:BaseImageVm_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="BaseImageVm_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:BaseImageVmInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name

Type

Description

_this

ManagedObjectReference

A reference to the BaseImageVm used to make the method call.

datacenter

DatacenterId

unique identifier for datacenter entry

filterIncompatibleVms

xsd: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
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="BaseImageVm_ListByDatacenter" type="vdi:BaseImageVm_ListByDatacenterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="BaseImageVm_ListByDatacenterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:BaseImageVmInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>