Service - Machine

Class: VMware.Hv.Machine
See also: MachineDeleteSpec, MachineId, MachineInfo, MachineRegisterResult, MachineRegisterSpec, MachineSummaryView, MapEntry
Since: Horizon View 6.0

Service Description

Service interface for Machine. A Machine is a single instance of any one of the following: Virtual Machine (Managed), Physical Machine (Unmanaged)

Methods

Methods defined in this Service
Machine_Delete, Machine_DeleteMachines, Machine_Get, Machine_GetInfos, Machine_GetSummaryView, Machine_GetSummaryViews, Machine_Recover, Machine_RecoverMachines, Machine_Register, Machine_Reset, Machine_ResetMachines, Machine_Update

Machine_Delete

Delete the machine.
Note :- If deleteFromDisk is true, then machine being deleted must not have any active user session, otherwise this operation would fail.

Privileges

Privilege	Description
MACHINE_MANAGEMENT	privilege is required to delete Machine configuration.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

MachineId

unique identifier of the machine to delete. MachineIds of this type must originate from the Machine service.

spec

MachineDeleteSpec

attributes needed to delete the Machine.

Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
None

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.

Events

Event	Description
VLSI_MACHINE_DELETED	if Machine was deleted.
VLSI_MACHINE_DELETE_FAILED	if the Machine delete failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_Delete" type="vdi:Machine_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_DeleteResponse">
            <complexType/>
         </element>

Machine_DeleteMachines

Delete the machines. This applies only to managed Machines.
Note :- If deleteFromDisk is true, then machines being deleted must not have any active user session, otherwise this operation would fail.

Privileges

Privilege	Description
MACHINE_MANAGEMENT	privilege is required to delete Machine configuration.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

ids

MachineId[]

Array of unique identifiers of the machines to delete. MachineIds of this type must originate from the Machine service.

spec

MachineDeleteSpec

attributes needed to delete the Machines.

Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
None

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.
PartialFailureFault	Thrown if delete operation fails on one or more Machines.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_MACHINE_DELETED	if Machine was deleted.
VLSI_MACHINE_DELETE_FAILED	if the Machine delete failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_DeleteMachines" type="vdi:Machine_DeleteMachinesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_DeleteMachinesResponse">
            <complexType/>
         </element>

Machine_Get

Gets the MachineInfo for the specified machine entry

Privileges

Privilege	Description
MACHINE_VIEW	privilege is required to read Machine configuration.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
id	MachineId	Unique identifier for the machine entry. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
MachineInfo	The MachineInfo

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="Machine_Get" type="vdi:Machine_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:MachineInfo"/>
               </sequence>
            </complexType>
         </element>

Machine_GetInfos

Gets the MachineInfo for the specified machine entries

Privileges

Privilege	Description
MACHINE_VIEW	privilege is required to read Machine configuration.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
ids	MachineId[]	Array of unique identifiers for the machine entries. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
MachineInfo[]	The MachineInfo array

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="Machine_GetInfos" type="vdi:Machine_GetInfosRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_GetInfosResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:MachineInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Machine_GetSummaryView

Gets the MachineSummaryView for the specified machine entry

Privileges

Privilege	Description
MACHINE_VIEW	privilege is required to read Machine configuration.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
id	MachineId	Unique identifier for the machine entry. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
MachineSummaryView	The MachineSummaryView

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="Machine_GetSummaryView" type="vdi:Machine_GetSummaryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_GetSummaryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:MachineSummaryView"/>
               </sequence>
            </complexType>
         </element>

Machine_GetSummaryViews

Gets the MachineSummaryViews for the specified machine entries

Privileges

Privilege	Description
MACHINE_VIEW	privilege is required to read Machine configuration.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
ids	MachineId[]	Array of unique identifiers for the machine entries. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
MachineSummaryView[]	The MachineSummaryView array

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="Machine_GetSummaryViews" type="vdi:Machine_GetSummaryViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_GetSummaryViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:MachineSummaryView" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Machine_Recover

Mark the machine for recovery. This operation deletes the current machine and provisions a new machine from latest image. Usually this operation is used to recover machine that is in error state or otherwise unusable. This operation applies only to machines belonging to Instant Clone Engine desktops.
Note :- The machine being recovered must not have any active user session, otherwise this operation would fail.

Privileges

Privilege	Description
MACHINE_MANAGEMENT	privilege is required to recover the Machine.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
id	MachineId	Unique identifier of the machine to recover. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
None

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.

Events

Event	Description
VLSI_MACHINE_RECOVERY_REQUESTED	if Machine was marked for recovery.
VLSI_MACHINE_RECOVERY_REQUEST_FAILED	if failed to mark the Machine for recovery.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_Recover" type="vdi:Machine_RecoverRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_RecoverResponse">
            <complexType/>
         </element>

Machine_RecoverMachines

Mark the machines for recovery. This operation deletes the current machines and provisions new machines from latest image. Usually this operation is used to recover machines that are in error state or otherwise unusable. This operation applies only to machines belonging to Instant Clone Engine desktops.
Note :- The machines being recovered must not have any active user session, otherwise this operation would fail.

Privileges

Privilege	Description
MACHINE_MANAGEMENT	privilege is required to recover the Machines.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
ids	MachineId[]	Array of unique identifiers of the machines to recover. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
None

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.
PartialFailureFault	Thrown if recover operation fails on one or more Machines.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_MACHINE_RECOVERY_REQUESTED	if Machine was marked for recovery.
VLSI_MACHINE_RECOVERY_REQUEST_FAILED	if failed to mark the Machine for recovery.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_RecoverMachines" type="vdi:Machine_RecoverMachinesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_RecoverMachinesResponse">
            <complexType/>
         </element>

Machine_Register

Registers a machine.

Privileges

Privilege	Description
GLOBAL_MACHINE_REGISTER	Global machine registration privilege is required to register a machine.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
spec	MachineRegisterSpec	The specification for the register operation.

Return Value

Type	Description
MachineRegisterResult	The registration result.

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.
InvalidRequest	Thrown if the machine cannot be registered in the specified desktop.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_MACHINE_REGISTERED	If the machine is successfully registered.
VLSI_MACHINE_REGISTRATION_FAILED	If the machine could not be registered.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_Register" type="vdi:Machine_RegisterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_RegisterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:MachineRegisterResult"/>
               </sequence>
            </complexType>
         </element>

Machine_Reset

Reset the machine. This applies only to managed Machine.

Privileges

Privilege	Description
MACHINE_REBOOT	privilege is required to reset Machine.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
id	MachineId	Unique identifier of the machine to reset. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
None

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.

Events

Event	Description
VLSI_MACHINE_RESET	if Machine was reset.
VLSI_MACHINE_RESET_FAILED	if the Machine reset failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_Reset" type="vdi:Machine_ResetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_ResetResponse">
            <complexType/>
         </element>

Machine_ResetMachines

Reset the machines. This applies only to managed Machines.

Privileges

Privilege	Description
MACHINE_REBOOT	privilege is required to reset Machine.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Machine used to make the method call.
ids	MachineId[]	Array of unique identifier of the machines to reset. MachineIds of this type must originate from the Machine service.

Return Value

Type	Description
None

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.
PartialFailureFault	Thrown if one or more Machines cannot be reset.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_MACHINE_RESET	if Machine was reset.
VLSI_MACHINE_RESET_FAILED	if the Machine reset failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_ResetMachines" type="vdi:Machine_ResetMachinesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_ResetMachinesResponse">
            <complexType/>
         </element>

Machine_Update

Updates the machine.

Privileges

Privilege	Description
MACHINE_MANAGEMENT	privilege is required to update Machine configuration.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

MachineId

The ID of the machine to update. MachineIds of this type must originate from the Machine service.

updates

MapEntry[]

The updates to apply

This parameter is an update map based on MachineInfo.

Return Value

Type	Description
None

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.

Events

Event	Description
VLSI_MACHINE_UPDATED	for each Machine attribute that was updated.
VLSI_MACHINE_UPDATE_FAILED	if the Machine update failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_Update" type="vdi:Machine_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Machine_UpdateResponse">
            <complexType/>
         </element>