Service - ViewComposerDomainAdministrator

Class: VMware.Hv.ViewComposerDomainAdministrator
See also: MapEntry, ServerDefinition, ViewComposerDomainAdministratorBase, ViewComposerDomainAdministratorId, ViewComposerDomainAdministratorInfo, ViewComposerDomainAdministratorSpec, VirtualCenterId
Since: Horizon View 6.0

Service Description

The view composer domain administrator service interface for processing accounts capable of adding/deleting computer accounts.

Methods

Methods defined in this Service
ViewComposerDomainAdministrator_Create, ViewComposerDomainAdministrator_CreateByServerDefinition, ViewComposerDomainAdministrator_Delete, ViewComposerDomainAdministrator_DeleteByServerDefinition, ViewComposerDomainAdministrator_Get, ViewComposerDomainAdministrator_List, ViewComposerDomainAdministrator_ListByServerDefinition, ViewComposerDomainAdministrator_listFarmAndDesktopNames, ViewComposerDomainAdministrator_Update, ViewComposerDomainAdministrator_UpdateByServerDefinition

Methods defined in this Service

ViewComposerDomainAdministrator_Create, ViewComposerDomainAdministrator_CreateByServerDefinition, ViewComposerDomainAdministrator_Delete, ViewComposerDomainAdministrator_DeleteByServerDefinition, ViewComposerDomainAdministrator_Get, ViewComposerDomainAdministrator_List, ViewComposerDomainAdministrator_ListByServerDefinition, ViewComposerDomainAdministrator_listFarmAndDesktopNames, ViewComposerDomainAdministrator_Update, ViewComposerDomainAdministrator_UpdateByServerDefinition

ViewComposerDomainAdministrator_Create

Add a view composer domain administrator.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to create a View Composer administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
spec	ViewComposerDomainAdministratorSpec	attributes needed to add a view composer domain administrator

Return Value

Type	Description
ViewComposerDomainAdministratorId	Entity id for the view composer 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
ADMIN_SVI_ADMIN_ADDED	If the View Composer administrator is added.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_Create" type="vdi:ViewComposerDomainAdministrator_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ViewComposerDomainAdministratorId"/>
               </sequence>
            </complexType>
         </element>

ViewComposerDomainAdministrator_CreateByServerDefinition

Adds a view composer domain administrator. This method can be used prior to adding View Composer in Horizon and hence it always expects View Composer Server details as input.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to create a View Composer administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
serverDefinition	ServerDefinition	Details required to connect to View Composer server.
base	ViewComposerDomainAdministratorBase	Domain administrator details to be added.

Return Value

Type	Description
ViewComposerDomainAdministratorId	Entity id for the view composer 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
ADMIN_SVI_ADMIN_ADDED	If the View Composer administrator is added.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_CreateByServerDefinition" type="vdi:ViewComposerDomainAdministrator_CreateByServerDefinitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_CreateByServerDefinitionResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ViewComposerDomainAdministratorId"/>
               </sequence>
            </complexType>
         </element>

ViewComposerDomainAdministrator_Delete

Delete a view composer admin.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to delete a View Composer administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
id	ViewComposerDomainAdministratorId	entity id for the view composer admin entry

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
ADMIN_SVI_ADMIN_REMOVED	If the administrator is removed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_Delete" type="vdi:ViewComposerDomainAdministrator_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_DeleteResponse">
            <complexType/>
         </element>

ViewComposerDomainAdministrator_DeleteByServerDefinition

Delete a view composer admin from the specified View Composer server. This method can be used prior to adding View Composer in Horizon and hence it always expects View Composer Server details as input.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to delete a View Composer administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
id	ViewComposerDomainAdministratorId	entity id for the view composer admin entry.
serverDefinition	ServerDefinition	Details required to connect to View Composer server.

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
ADMIN_SVI_ADMIN_REMOVED	If the administrator is removed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_DeleteByServerDefinition" type="vdi:ViewComposerDomainAdministrator_DeleteByServerDefinitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_DeleteByServerDefinitionResponse">
            <complexType/>
         </element>

ViewComposerDomainAdministrator_Get

Gets the View Composer domain administrator information (primarily the list of attributes about configured view composer administrator). Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to get a View Composer domain administrator.
POOL_VIEW	privilege is required to get a View Composer domain administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
id	ViewComposerDomainAdministratorId	entity id for the view composer admin entry.

Return Value

Type	Description
ViewComposerDomainAdministratorInfo	ViewComposerDomainAdministratorInfo (attributes about configured view composer 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="ViewComposerDomainAdministrator_Get" type="vdi:ViewComposerDomainAdministrator_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ViewComposerDomainAdministratorInfo"/>
               </sequence>
            </complexType>
         </element>

ViewComposerDomainAdministrator_List

Gets list of info (primarily the list of attributes about configured view composer administrators). Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to list View Composer administrators.
POOL_VIEW	privilege is required to list View Composer administrators.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
virtualCenter	VirtualCenterId	entity id for the virtual center related to the view composer server

Return Value

Type	Description
ViewComposerDomainAdministratorInfo[]	list of ViewComposerDomainAdministratorInfo (attributes about configured view composer 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="ViewComposerDomainAdministrator_List" type="vdi:ViewComposerDomainAdministrator_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ViewComposerDomainAdministratorInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ViewComposerDomainAdministrator_ListByServerDefinition

Lists the View Composer domain administrators from the specified View Composer server. This method can be used prior to adding View Composer in Horizon and hence it always expects View Composer Server details as input.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to list View Composer administrators.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
serverDefinition	ServerDefinition	Details required to connect to View Composer server.

Return Value

Type	Description
ViewComposerDomainAdministratorInfo[]	list of ViewComposerDomainAdministratorInfo (attributes about configured view composer 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="ViewComposerDomainAdministrator_ListByServerDefinition" type="vdi:ViewComposerDomainAdministrator_ListByServerDefinitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_ListByServerDefinitionResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ViewComposerDomainAdministratorInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ViewComposerDomainAdministrator_listFarmAndDesktopNames

List the name of Farms and Desktops for the given View Composer domain administrator alongwith the authorized user

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to fetch the Desktop and Farm names for a given View Composer domain administrator alongwith the authorized user

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
id	ViewComposerDomainAdministratorId	entity id for the View Composer domain administrator entry

Return Value

Type	Description
xsd:string[]	Array of the String containing name of Farms and Desktops for the given View Composer domain administrator alongwith the authorized user

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="ViewComposerDomainAdministrator_listFarmAndDesktopNames" type="vdi:ViewComposerDomainAdministrator_listFarmAndDesktopNamesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_listFarmAndDesktopNamesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ViewComposerDomainAdministrator_Update

Update view composer admin with the set of attributes in the map.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to update a View Composer administrator.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

ViewComposerDomainAdministratorId

entity id for the view composer admin entry

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on ViewComposerDomainAdministratorInfo.

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
ADMIN_SVI_ADMIN_UPDATED	If the update is completed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_Update" type="vdi:ViewComposerDomainAdministrator_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_UpdateResponse">
            <complexType/>
         </element>

ViewComposerDomainAdministrator_UpdateByServerDefinition

Update view composer admin with the set of attributes in the map. This method can be used prior to adding View Composer in Horizon and hence it always expects View Composer Server details as input.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to update a View Composer administrator.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewComposerDomainAdministrator used to make the method call.
id	ViewComposerDomainAdministratorId	entity id for the view composer admin entry.
serverDefinition	ServerDefinition	Details required to connect to View Composer server.
updates	MapEntry[]	key value pairs describing attributes to be updated This parameter is an update map based on ViewComposerDomainAdministratorInfo.

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
ADMIN_SVI_ADMIN_UPDATED	If the update is completed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_UpdateByServerDefinition" type="vdi:ViewComposerDomainAdministrator_UpdateByServerDefinitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ViewComposerDomainAdministrator_UpdateByServerDefinitionResponse">
            <complexType/>
         </element>