| Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |
Methods
Methods defined in this Service |
---|
VirtualCenter_Create, VirtualCenter_Delete, VirtualCenter_Get, VirtualCenter_List, VirtualCenter_Update |
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. |
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. |
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. |
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. |
Privileges
Privilege | Description |
---|---|
GLOBAL_CONFIG_VIEW | Global configuration view 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. |
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. |
id | VirtualCenterId |
unique identifier for virtual center entry
|
updates | MapEntry[] |
key value pairs describing attributes to be updated
|
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. |
Top of page | Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |