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
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
Return Value
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_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
Return Value
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. |
InvalidState | Thrown when there are Desktops present in the Pod with this Virtual Center Id. |
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_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
Return Value
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
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
Return Value
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
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
Return Value
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
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
Return Value
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
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
Return Value
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_VC_EDITED |
If the Virtual Center was successfully updated.
|
Show WSDL type definition
© 2022 VMware, Inc. All rights reserved.
Revision Sep-2022 Version 8.7.0