Service - VirtualCenter

Class
VMware.Hv.VirtualCenter
See also
MapEntry, ServerDefinition, UnsupportedDesktopOrFarmDetails, VirtualCenterFeatureDetails, VirtualCenterId, VirtualCenterInfo, VirtualCenterSpec
Since
Horizon View 6.0


Service Description

The virtual center service interface.

Methods

Methods defined in this Service
VirtualCenter_Create, VirtualCenter_Delete, VirtualCenter_Get, VirtualCenter_GetFeatureDetailsByServerDefinition, VirtualCenter_List, VirtualCenter_ListUnsupportedDesktopsAndFarmsForVMC, VirtualCenter_Update

VirtualCenter_Create

Add a virtual center server to the view instance.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management is required to create a Virtual Center server.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualCenter used to make the method call.
specVirtualCenterSpec

attributes needed to add a virtual center server

Return Value

Type Description
VirtualCenterIdunique identifier for the vc server

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_VC_ADDED If the Virtual Center was successfully created.
ADMIN_VC_LICINV_ALARM_DISABLED If the Virtual Center Inventory License Alarm was successfully disabled as part of the creation.
ADMIN_VC_ADD_FAILED If the Virtual Center could not be created.

Show WSDL type definition



VirtualCenter_Delete

Delete a virtual center server from the view instance.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management is required to delete a Virtual Center server.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualCenter used to make the method call.
idVirtualCenterId

unique identifier for a virtual center 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.
InvalidStateThrown when there are Desktops present in the Pod with this Virtual Center Id.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
ADMIN_VC_REMOVED If the Virtual Center was successfully deleted.
ADMIN_VC_REMOVE_FAILED If the Virtual Center could not be deleted.

Show WSDL type definition



VirtualCenter_Get

Gets the VcInformation for a specific virtual center entry.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration view is required to retrieve information about a Virtual Center server.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualCenter used to make the method call.
idVirtualCenterId

unique identifier for vc entry

Return Value

Type Description
VirtualCenterInfoThe VirtualCenterInfo

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



VirtualCenter_GetFeatureDetailsByServerDefinition

Gets the Virtual Center feature details. Using a ServerDefinition allows querying the virtualCenter before it has been added to the environment.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration (read-only) is required to get information on View Storage Accelerator.
VC_CONFIG_VIEW privilege is required to get information about View Storage Accelerator support on a Virtual Center.

Parameters

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

Object needed to connect to a server.

Return Value

Type Description
VirtualCenterFeatureDetailsVirtualCenterFeatureDetails.

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



VirtualCenter_List

Gets list of VcInfo (primarily the list of attributes about configured virtual center servers). Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration view is required to list Virtual Center servers.
VC_CONFIG_VIEW privilege is required to list Virtual Center servers.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualCenter used to make the method call.

Return Value

Type Description
VirtualCenterInfo[]The VirtualCenterInfo list

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



VirtualCenter_ListUnsupportedDesktopsAndFarmsForVMC

List the details of farms and/or desktops which are unsupported for VMC.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW configuration view is required to list the desktop and farms

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualCenter used to make the method call.
idVirtualCenterId

virtual center id

Return Value

Type Description
UnsupportedDesktopOrFarmDetails[]The array containing the details of farms and desktops which are unsupported for VMC

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



VirtualCenter_Update

Update virtual center server with the set of attributes in the map.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management is required to update a Virtual Center server.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualCenter used to make the method call.
idVirtualCenterId

unique identifier for virtual center 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_VC_EDITED If the Virtual Center was successfully updated.

Show WSDL type definition