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_Restart, Machine_RestartMachines, 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.
|
id | 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
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
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
Faults
Events
Event
|
Description
|
VLSI_MACHINE_DELETED |
if Machine was deleted.
|
VLSI_MACHINE_DELETE_FAILED |
if the Machine delete failed.
|
Show WSDL type definition
Machine_Get
Gets the MachineInfo for the specified machine entry
Privileges
Privilege
|
Description
|
MACHINE_VIEW |
privilege is required to read Machine
configuration.
|
Parameters
Return Value
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
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
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
Machine_GetSummaryView
Gets the MachineSummaryView for the specified machine entry
Privileges
Privilege
|
Description
|
MACHINE_VIEW |
privilege is required to read Machine
configuration.
|
Parameters
Return Value
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
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
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
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
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
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
Faults
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
Machine_Register
Registers a machine.
Privileges
Privilege
|
Description
|
GLOBAL_MACHINE_REGISTER |
Global machine registration privilege
is required to register a machine.
|
Parameters
Return Value
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
Machine_Reset
Reset the machine. This applies only to managed Machine.
Privileges
Privilege
|
Description
|
MACHINE_REBOOT |
privilege is required to reset Machine.
|
Parameters
Return Value
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
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
Faults
Events
Event
|
Description
|
VLSI_MACHINE_RESET |
if Machine was reset.
|
VLSI_MACHINE_RESET_FAILED |
if the Machine reset failed.
|
Show WSDL type definition
Machine_Restart
Restart the machine. This applies only to managed Machine.
Privileges
Privilege
|
Description
|
MACHINE_REBOOT |
privilege is required to restart 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 restart. MachineIds of this
type must originate from the Machine service.
|
Return Value
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_RESTART |
if Machine was restarted.
|
VLSI_MACHINE_RESTART_FAILED |
if the Machine restart failed.
|
Show WSDL type definition
Machine_RestartMachines
Restart the machines. This applies only to managed Machines.
Privileges
Privilege
|
Description
|
MACHINE_REBOOT |
privilege is required to restart 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 restart. MachineIds
of this type must originate from the Machine service.
|
Return Value
Faults
Events
Event
|
Description
|
VLSI_MACHINE_RESTART |
if Machine was restarted.
|
VLSI_MACHINE_RESTART_FAILED |
if the Machine restart failed.
|
Show WSDL type definition
Machine_Update
Updates the machine.
Privileges
Privilege
|
Description
|
MACHINE_MANAGEMENT |
privilege is required to update Machine
configuration.
|
Parameters
Return Value
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
© 2017 VMware, Inc. All rights reserved.
Revision 17-Mar-2017 Version 7.1.0