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

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualCenter used to make the method call.
spec	VirtualCenterSpec	attributes needed to add a virtual center server

Return Value

Type	Description
VirtualCenterId	unique identifier for the vc server

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_Create" type="vdi:VirtualCenter_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:VirtualCenterId"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualCenter used to make the method call.
id	VirtualCenterId	unique identifier for a virtual center 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.
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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_Delete" type="vdi:VirtualCenter_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_DeleteResponse">
            <complexType/>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualCenter used to make the method call.
id	VirtualCenterId	unique identifier for vc entry

Return Value

Type	Description
VirtualCenterInfo	The VirtualCenterInfo

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="VirtualCenter_Get" type="vdi:VirtualCenter_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:VirtualCenterInfo"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualCenter used to make the method call.
serverDefinition	ServerDefinition	Object needed to connect to a server.

Return Value

Type	Description
VirtualCenterFeatureDetails	VirtualCenterFeatureDetails.

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="VirtualCenter_GetFeatureDetailsByServerDefinition" type="vdi:VirtualCenter_GetFeatureDetailsByServerDefinitionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_GetFeatureDetailsByServerDefinitionResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:VirtualCenterFeatureDetails"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualCenter used to make the method call.

Return Value

Type	Description
VirtualCenterInfo[]	The VirtualCenterInfo list

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="VirtualCenter_List" type="vdi:VirtualCenter_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:VirtualCenterInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualCenter used to make the method call.
id	VirtualCenterId	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
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="VirtualCenter_ListUnsupportedDesktopsAndFarmsForVMC" type="vdi:VirtualCenter_ListUnsupportedDesktopsAndFarmsForVMCRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_ListUnsupportedDesktopsAndFarmsForVMCResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:UnsupportedDesktopOrFarmDetails" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name

Type

Description

_this

ManagedObjectReference

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

VirtualCenterId

unique identifier for virtual center entry

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on VirtualCenterInfo.

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_VC_EDITED	If the Virtual Center was successfully updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_Update" type="vdi:VirtualCenter_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="VirtualCenter_UpdateResponse">
            <complexType/>
         </element>