| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
childEntity* P | ManagedObjectReference[]
to a ManagedEntity[] |
|
childType* P | xsd:string[] |
|
namespace* P | xsd:string |
Since vSphere API 7.0 |
Properties inherited from ManagedEntity | ||
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState | ||
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
AddStandaloneHost_Task, BatchAddHostsToCluster_Task, BatchAddStandaloneHosts_Task, CreateCluster, CreateClusterEx, CreateDatacenter, CreateDVS_Task, CreateFolder, CreateStoragePod, CreateVM_Task, MoveIntoFolder_Task, RegisterVM_Task, UnregisterAndDestroy_Task |
Methods inherited from ManagedEntity |
Destroy_Task, Reload, Rename_Task |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
spec P | HostConnectSpec |
Since null |
compResSpec* P | ComputeResourceConfigSpec |
Since null |
addConnected P | xsd:boolean |
Since null |
license* P | xsd:string |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DuplicateName | |
HostConnectFault | |
InvalidLogin | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
cluster P | ManagedObjectReference
to a ClusterComputeResource |
Since vSphere API 6.7.1 |
newHosts* P | FolderNewHostSpec[] |
Since vSphere API 6.7.1 |
existingHosts* P | ManagedObjectReference[]
to a HostSystem[] |
Since vSphere API 6.7.1 |
compResSpec* P | ComputeResourceConfigSpec |
Since vSphere API 6.7.1 |
desiredState* P | xsd:string |
Since vSphere API 6.7.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
newHosts* P | FolderNewHostSpec[] |
Since vSphere API 6.7.1 |
compResSpec* P | ComputeResourceConfigSpec |
Since vSphere API 6.7.1 |
addConnected P | xsd:boolean |
Since vSphere API 6.7.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
name P | xsd:string |
Since null |
spec P | ClusterConfigSpec |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ClusterComputeResource |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidName | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
name P | xsd:string |
Since VI API 2.5 |
spec P | ClusterConfigSpecEx |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ClusterComputeResource |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidName | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
name P | xsd:string |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Datacenter |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidName | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
spec P | DVSCreateSpec |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DuplicateName | |
DvsFault | |
DvsNotAuthorized | |
InvalidName | |
NotFound | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
name P | xsd:string |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Folder |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidName | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
name P | xsd:string |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a StoragePod |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidName | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
config P | VirtualMachineConfigSpec |
Since null |
pool P | ManagedObjectReference
to a ResourcePool |
Since null |
host* P | ManagedObjectReference
to a HostSystem |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
AlreadyExists | |
DuplicateName | |
FileFault | |
InsufficientResourcesFault | |
InvalidDatastore | |
InvalidName | |
InvalidState | |
OutOfBounds | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VmConfigFault |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
list P | ManagedObjectReference[]
to a ManagedEntity[] |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidFolder | |
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
path P | xsd:string |
Since null |
name* P | xsd:string |
Since null |
asTemplate P | xsd:boolean |
Since null |
pool* P | ManagedObjectReference
to a ResourcePool |
Since null |
host* P | ManagedObjectReference
to a HostSystem |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
AlreadyExists | |
DuplicateName | |
FileFault | |
InsufficientResourcesFault | |
InvalidDatastore | |
InvalidName | |
InvalidState | |
NotFound | |
OutOfBounds | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VmConfigFault |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Folder used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ConverterTask |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |