Service -
Machine
- Class
- VMware.Hv.Machine
- See also
-
MachineAliasUpdateSpec, MachineDeleteSpec, MachineId, MachineInfo, MachineRegisterResult, MachineRegisterSpec, MachineStateCounts, MachineSummaryView, MapEntry, UserOrGroupId
- 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_assignUsers, Machine_CancelTasks, Machine_Delete, Machine_DeleteMachines, Machine_EnterMaintenanceMode, Machine_EnterMaintenanceModeMachines, Machine_ExitMaintenanceMode, Machine_ExitMaintenanceModeMachines, Machine_Get, Machine_GetInfos, Machine_GetStateCounts, Machine_GetSummaryView, Machine_GetSummaryViews, Machine_Rebuild, Machine_RebuildMachines, Machine_Recover, Machine_RecoverMachines, Machine_Register, Machine_Reset, Machine_ResetMachines, Machine_Restart, Machine_RestartMachines, Machine_unassignUsers, Machine_Update, Machine_UpdateMachineAliases |
Machine_assignUsers
Assign the given user(s) to this machine. For single user machines this
method resets the assignment, if present. Assignments are only allowed for
users, not for groups.
Privileges
Privilege
|
Description
|
MACHINE_USER_MANAGEMENT |
privilege is required to assign 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 be assigned. MachineIds of
this type must originate from the Machine service.
|
userIds | UserOrGroupId[] |
Unique identifiers of the users for assignment. UserIds of this
type must originate from the ADUserOrGroup service.
|
Return Value
Faults
Events
Event
|
Description
|
VLSI_MACHINE_UPDATED |
if one or more user is assigned successfully.
|
VLSI_MACHINE_UPDATE_FAILED |
if no user is assigned.
|
Show WSDL type definition
Machine_CancelTasks
Cancel pending tasks on the specified machines related to Linked-Clone
rebalance/recompose/refresh operations.
Privileges
Privilege
|
Description
|
POOL_SVI_IMAGE_MANAGEMENT |
Manage Composer Desktop Pool Image
privilege is required on each of the machines to cancel the
respective pending tasks.
|
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. |
PartialFailureFault | Thrown if all operations were not successful, a PartialFailureFault will be thrown indicating cancel task on which machines were successful and which ones failed. The index of results in the PartialFailureFault corresponds to the machine's index in request. The result entry will contain either the original return type (on success) or an exception (on failure). |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
VLSI_VIEW_COMPOSER_OPERATION_CANCELED |
if Machine was marked for
cancelling the pending tasks.
|
VLSI_VIEW_COMPOSER_OPERATION_CANCEL_FAILED |
if failed to mark the
Machine for cancelling the pending tasks.
|
Show WSDL type definition
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. Requires at least one of the listed privileges.
Privileges
Privilege
|
Description
|
MACHINE_MANAGEMENT |
privilege is required to delete Machine
configuration.
|
POOL_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. Requires at least one of the listed privileges.
Privileges
Privilege
|
Description
|
MACHINE_MANAGEMENT |
privilege is required to delete Machine
configuration.
|
POOL_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_EnterMaintenanceMode
Mark the machine for maintenance. This operation puts the current
machine into maintenance mode.
Privileges
Privilege
|
Description
|
MACHINE_MAINTENANCE |
privilege is required to perform maintenance.
|
FORENSICS |
privilege is required to perform maintenance on held 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_MAINTENANCE |
if Machine entered maintenance mode successfully.
|
VLSI_MACHINE_MAINTENANCE_FAILED |
if the Machine failed to enter maintenance mode.
|
Show WSDL type definition
Machine_EnterMaintenanceModeMachines
Mark machines for maintenance. For each machine, this operation puts
the current machine into maintenance mode.
Privileges
Privilege
|
Description
|
MACHINE_MAINTENANCE |
privilege is required to perform maintenance.
|
FORENSICS |
privilege is required to perform maintenance on held machines.
|
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. |
PartialFailureFault | Thrown if enter maintenance operation fails on one or more Machines. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
VLSI_MACHINE_MAINTENANCE |
if Machine entered maintenance mode successfully.
|
VLSI_MACHINE_MAINTENANCE_FAILED |
if the Machine failed to enter maintenance mode.
|
Show WSDL type definition
Machine_ExitMaintenanceMode
Mark the machine out of maintenance. This operation takes the current
machine out of maintenance mode.
Privileges
Privilege
|
Description
|
MACHINE_MAINTENANCE |
privilege is required to perform maintenance.
|
FORENSICS |
privilege is required to perform maintenance on held 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_MAINTENANCE |
if Machine exited maintenance mode successfully.
|
VLSI_MACHINE_MAINTENANCE_FAILED |
if the Machine failed to exit maintenance mode.
|
Show WSDL type definition
Machine_ExitMaintenanceModeMachines
Mark machines out of maintenance. For each machine, this operation takes
the current machine out of maintenance mode.
Privileges
Privilege
|
Description
|
MACHINE_MAINTENANCE |
privilege is required to perform maintenance.
|
FORENSICS |
privilege is required to perform maintenance on held machines.
|
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. |
PartialFailureFault | Thrown if exit maintenance operation fails on one or more Machines. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
VLSI_MACHINE_MAINTENANCE |
if Machine exited maintenance mode successfully.
|
VLSI_MACHINE_MAINTENANCE_FAILED |
if the Machine failed to exit maintenance mode.
|
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_GetStateCounts
Returns the counters for various machine states.
Privileges
Privilege
|
Description
|
MACHINE_VIEW |
privilege is required to get Machine
state counts.
|
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_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_Rebuild
Mark the machine for rebuilding. This operation deletes the current
machine and provisions a new machine with the same name. Usually this
operation is performed to rebuild a dedicated machine that is in error
state or otherwise unusable. This operation applies only to machines
belonging to Full Clone desktops.
Privileges
Privilege
|
Description
|
MACHINE_MANAGEMENT |
privilege is required to rebuild 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 rebuild. 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_REBUILD |
if Machine was rebuilt.
|
VLSI_MACHINE_REBUILD_FAILED |
if the Machine rebuild failed.
|
Show WSDL type definition
Machine_RebuildMachines
Mark machines for rebuilding. For each machine, this operation deletes
the current machine and provisions a new machine with the same name.
Usually this operation is performed to rebuild a dedicated machine that
is in error state or otherwise unusable. This operation applies only to
machines belonging to Full Clone desktops.
Privileges
Privilege
|
Description
|
MACHINE_MANAGEMENT |
privilege is required to rebuild 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 rebuild.
MachineIds of this type must originate from the
Machine service.
|
Return Value
Faults
Events
Event
|
Description
|
VLSI_MACHINE_REBUILD |
if Machine was rebuilt.
|
VLSI_MACHINE_REBUILD_FAILED |
if the Machine rebuild failed.
|
Show WSDL type definition
Machine_Recover
Mark the machine for recovery. This operation recovers machine that is in
error state or otherwise unusable. This operation applies only to machines
belonging to Instant Clone Engine desktops.
For floating Instant Clone Engine pools, this operation deletes the
current machine and provisions a new machine from the latest image.
For dedicated Instant Clone Engine pools, this operation resyncs the
current machine to the latest image. During this operation, the OS disk
of specified machine will be replaced with the one that was generated
based on the source template.
Note :- The machine being recovered must not have any active user session,
otherwise this operation would fail. Requires at least one of the listed
privileges.
Privileges
Privilege
|
Description
|
MACHINE_MANAGEMENT |
privilege is required to recover the
Machine.
|
POOL_MANAGEMENT |
privilege is required to recover the
Machine.
|
FORENSICS |
privilege is required to recover held 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 recovers machines that are
in error state or otherwise unusable. This operation applies only to
machines belonging to Instant Clone Engine desktops.
For floating Instant Clone Engine pools, this operation deletes the
current machines and provisions a machines from the latest image.
For dedicated Instant Clone Engine pools, this operation resyncs the
current machines to the latest image. During this operation, the OS disk
of specified machines will be replaced with the one that was generated
based on the source template.
Note :- The machines being recovered must not have any active user
session, otherwise this operation would fail. Requires at least one
of the listed privileges.
Privileges
Privilege
|
Description
|
MACHINE_MANAGEMENT |
privilege is required to recover the
Machines.
|
POOL_MANAGEMENT |
privilege is required to recover the
Machines.
|
FORENSICS |
privilege is required to recover held 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.
|
FORENSICS |
privilege is required to reset held 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.
|
FORENSICS |
privilege is required to reset held 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.
|
FORENSICS |
privilege is required to restart held 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.
|
FORENSICS |
privilege is required to restart held 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_unassignUsers
Unassign the given user(s) from this machine.
Unassignments are only allowed for users, not for groups.
Privileges
Privilege
|
Description
|
MACHINE_USER_MANAGEMENT |
privilege is required to assign 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 be unassigned. MachineIds of
this type must originate from the Machine service.
|
userIds | UserOrGroupId[] |
Unique identifiers of the users for unassignment. UserIds of this
type must originate from the ADUserOrGroup service.
|
Return Value
Faults
Events
Event
|
Description
|
VLSI_MACHINE_UPDATED |
if one or more user is unassigned successfully.
|
VLSI_MACHINE_UPDATE_FAILED |
if no user is unassigned.
|
Show WSDL type definition
Machine_Update
Updates the machine.
NOTE: This operation will fail if user field is updated
for machine belonging to pools with "allowMultipleAssignments" enabled. Use
Machine_assignUsers or Machine_unassignUsers for assigning or unassigning
users.
Privileges
Privilege
|
Description
|
MACHINE_MAINTENANCE |
privilege is required to update machine maintenance state
|
MACHINE_USER_MANAGEMENT |
privilege is required to update user assignment
|
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
Machine_UpdateMachineAliases
Updates the machine aliases of the assigned users. Machine alias will be
updated if the assigned user already has the machine alias set, otherwise
provided machine alias is set for the user. Machine alias will be removed
for the assigned user if alias is set to null. If no
machine alias is provided in the spec for an assigned user, existing
machine alias is retained for that user.
Privileges
Privilege
|
Description
|
MACHINE_USER_MANAGEMENT |
privilege is required to update the machine
alias of the assigned user.
|
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. |
PartialFailureFault | Thrown if aliases contain more than one alias for the same user or if the alias is present for the unassigned user. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event
|
Description
|
VLSI_MACHINE_UPDATED |
if one or more user's machine alias is added,
removed or updated successfully.
|
VLSI_MACHINE_UPDATE_FAILED |
if none of the user's machine alias is
added, removed or updated.
|
Show WSDL type definition
© 2023 VMware, Inc. All rights reserved.
Revision Dec-2023 Version 8.12.0