Service - InstantCloneEngineDomainAdministrator

Class: VMware.Hv.InstantCloneEngineDomainAdministrator
See also: InstantCloneEngineDomainAdministratorId, InstantCloneEngineDomainAdministratorInfo, InstantCloneEngineDomainAdministratorSpec, MapEntry
Since: Horizon 7.0

Service Description

The Instant Clone Engine domain administrator service interface for processing accounts capable of adding/deleting computer accounts.

Methods

Methods defined in this Service
InstantCloneEngineDomainAdministrator_Create, InstantCloneEngineDomainAdministrator_Delete, InstantCloneEngineDomainAdministrator_Get, InstantCloneEngineDomainAdministrator_List, InstantCloneEngineDomainAdministrator_Update

InstantCloneEngineDomainAdministrator_Create

Add Instant Clone Engine domain administrator.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to create Instant Clone Engine domain administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the InstantCloneEngineDomainAdministrator used to make the method call.
spec	InstantCloneEngineDomainAdministratorSpec	attributes needed to add Instant Clone Engine domain administrator.

Return Value

Type	Description
InstantCloneEngineDomainAdministratorId	Entity id for the Instant Clone Engine domain administrator.

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_INSTANT_CLONE_ADMIN_CREATED	If the instant clone domain administrator was successfully created.
VLSI_INSTANT_CLONE_ADMIN_CREATE_FAILED	If the instant clone domain administrator could not be created.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_Create" type="vdi:InstantCloneEngineDomainAdministrator_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:InstantCloneEngineDomainAdministratorId"/>
               </sequence>
            </complexType>
         </element>

InstantCloneEngineDomainAdministrator_Delete

Delete Instant Clone Engine domain administrator. There must be no desktops associated with it.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to delete Instant Clone Engine domain administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the InstantCloneEngineDomainAdministrator used to make the method call.
id	InstantCloneEngineDomainAdministratorId	entity id for the Instant Clone Engine domain administrator entry.

Return Value

Type	Description
None

Faults

Type	Description
EntityInUse	Thrown if a desktop is associated with this instant clone engine domain administrator.
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_INSTANT_CLONE_ADMIN_DELETED	If the instant clone domain administrator was successfully deleted.
VLSI_INSTANT_CLONE_ADMIN_DELETE_FAILED	If the instant clone domain administrator could not be deleted.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_Delete" type="vdi:InstantCloneEngineDomainAdministrator_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_DeleteResponse">
            <complexType/>
         </element>

InstantCloneEngineDomainAdministrator_Get

Gets info (primarily the list of attributes about configured Instant Clone Engine domain administrator).

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is sufficient to get a Instant Clone Engine domain administrator.
POOL_VIEW	Desktop read privilege with any access group is sufficient to get a Instant Clone Engine domain administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the InstantCloneEngineDomainAdministrator used to make the method call.
id	InstantCloneEngineDomainAdministratorId	entity id for the Instant Clone Engine domain administrator entry.

Return Value

Type	Description
InstantCloneEngineDomainAdministratorInfo	InstantCloneEngineDomainAdministratorInfo (attributes about configured Instant Clone Engine domain administrator).

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="InstantCloneEngineDomainAdministrator_Get" type="vdi:InstantCloneEngineDomainAdministrator_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:InstantCloneEngineDomainAdministratorInfo"/>
               </sequence>
            </complexType>
         </element>

InstantCloneEngineDomainAdministrator_List

Gets list of Instant Clone Engine domain administrators.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is sufficient to list Instant Clone Engine domain administrators.
POOL_VIEW	Desktop read privilege with any access group is sufficient to list Instant Clone Engine domain administrators.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the InstantCloneEngineDomainAdministrator used to make the method call.

Return Value

Type	Description
InstantCloneEngineDomainAdministratorInfo[]	list of InstantCloneEngineDomainAdministratorInfo (attributes about configured Instant Clone Engine domain administrators).

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="InstantCloneEngineDomainAdministrator_List" type="vdi:InstantCloneEngineDomainAdministrator_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:InstantCloneEngineDomainAdministratorInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

InstantCloneEngineDomainAdministrator_Update

Update Instant Clone Engine domain administrator with the set of attributes in the map.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to update Instant Clone Engine domain administrator.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

InstantCloneEngineDomainAdministratorId

entity id for the Instant Clone Engine domain administrator entry.

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on InstantCloneEngineDomainAdministratorInfo.

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_INSTANT_CLONE_ADMIN_UPDATED	If the instant clone domain administrator was successfully updated.
VLSI_INSTANT_CLONE_ADMIN_UPDATE_FAILED	If the instant clone domain administrator could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_Update" type="vdi:InstantCloneEngineDomainAdministrator_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="InstantCloneEngineDomainAdministrator_UpdateResponse">
            <complexType/>
         </element>