Service - ViewComposerDomainAdministrator

Class
VMware.Hv.ViewComposerDomainAdministrator
See also
MapEntry, 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_Delete, ViewComposerDomainAdministrator_Get, ViewComposerDomainAdministrator_List, ViewComposerDomainAdministrator_Update

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

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_Delete

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_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

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

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_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

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