Service - ViewComposerDomainAdministrator

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


Service Description

Deprecated. This is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

ViewComposerDomainAdministrator_Create

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

Add a view composer domain administrator.

Privileges

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
specViewComposerDomainAdministratorSpec

attributes needed to add a view composer domain administrator

Return Value

Type Description
ViewComposerDomainAdministratorIdEntity id for the view composer domain administrator.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



ViewComposerDomainAdministrator_CreateByServerDefinition

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
serverDefinitionServerDefinition

Details required to connect to View Composer server.
baseViewComposerDomainAdministratorBase

Domain administrator details to be added.

Return Value

Type Description
ViewComposerDomainAdministratorIdEntity id for the view composer domain administrator.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



ViewComposerDomainAdministrator_Delete

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

Delete a view composer admin.

Privileges

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
idViewComposerDomainAdministratorId

entity id for the view composer admin entry

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



ViewComposerDomainAdministrator_DeleteByServerDefinition

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
idViewComposerDomainAdministratorId

entity id for the view composer admin entry.
serverDefinitionServerDefinition

Details required to connect to View Composer server.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



ViewComposerDomainAdministrator_Get

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
idViewComposerDomainAdministratorId

entity id for the view composer admin entry.

Return Value

Type Description
ViewComposerDomainAdministratorInfoViewComposerDomainAdministratorInfo (attributes about configured view composer administrator)

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ViewComposerDomainAdministrator_List

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
virtualCenterVirtualCenterId

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
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ViewComposerDomainAdministrator_ListByServerDefinition

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
serverDefinitionServerDefinition

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
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ViewComposerDomainAdministrator_listFarmAndDesktopNames

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
idViewComposerDomainAdministratorId

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
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ViewComposerDomainAdministrator_Update

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
idViewComposerDomainAdministratorId

entity id for the view composer admin entry
updatesMapEntry[]

key value pairs describing attributes to be updated

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



ViewComposerDomainAdministrator_UpdateByServerDefinition

Deprecated. This API is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

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

NameTypeDescription
_thisManagedObjectReference A reference to the ViewComposerDomainAdministrator used to make the method call.
idViewComposerDomainAdministratorId

entity id for the view composer admin entry.
serverDefinitionServerDefinition

Details required to connect to View Composer server.
updatesMapEntry[]

key value pairs describing attributes to be updated

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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