# Managed Object - ResourcePool

Property of
  ClusterClusterInitialPlacementAction, ClusterInitialPlacementAction, ComputeResource, ConverterAgentInternalManagedVMOptions, ConverterTargetVmSpecManagedVmLocation, NodeDeploymentSpec, OvfResourceMap, ResourcePool, ResourcePoolEventArgument, StoragePlacementSpec, VAppCloneSpecResourceMap, VirtualMachine, VirtualMachineImportSpec, VirtualMachineRelocateSpec
Parameter to
  AddHost_Task, CheckCompatibility_Task, CheckMigrate_Task, CheckPowerOn_Task, CheckVmConfig_Task, CloneVApp_Task, CreateImportSpec, CreateVM_Task, MarkAsVirtualMachine, MigrateVM_Task, MoveHostInto_Task, RecommendHostsForVm, RegisterVM_Task, ValidateMigration
Returned by
  CreateResourcePool
Extended by
  VirtualApp
Extends
  ManagedEntity
See also
  ComputeResource, Folder, HostSystem, HttpNfcLease, ImportSpec, ManagedEntity, ResourceConfigOption, ResourceConfigSpec, ResourcePoolRuntimeInfo, ResourcePoolSummary, VAppConfigSpec, VirtualApp, VirtualMachine, VirtualMachineConfigSpec
Since
  null

## Managed Object Description

Properties

Name | Type | Description
--- | --- | ---
childConfiguration* | ResourceConfigSpec[] |
config | ResourceConfigSpec |
namespace* P | xsd:string | Since vSphere API 7.0
owner P | ManagedObjectReference to a ComputeResource |
resourcePool* P | ManagedObjectReference[] to a ResourcePool[] |
runtime | ResourcePoolRuntimeInfo |
summary | ResourcePoolSummary |
vm* P | ManagedObjectReference[] to a VirtualMachine[] |
Properties inherited from ManagedEntity
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be present P Required privilege: System.View

Methods

Methods defined in this Managed Object
CreateChildVM_Task, CreateResourcePool, CreateVApp, DestroyChildren, ImportVApp, MoveIntoResourcePool, QueryResourceConfigOption, RefreshRuntime, RegisterChildVM_Task, UpdateChildResourceConfiguration, UpdateConfig
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

# CreateChildVM_Task

Required Privileges
  VirtualMachine.Inventory.Create
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
config P | VirtualMachineConfigSpec | Since vSphere API 4.0
host* P | ManagedObjectReference to a HostSystem | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidName |
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

# CreateResourcePool

Required Privileges
  Resource.CreatePool

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
name P | xsd:string | Since null
spec P | ResourceConfigSpec | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ResourcePool |

Faults

Type | Description
--- | ---
DuplicateName |
InsufficientResourcesFault |
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

# CreateVApp

Required Privileges
  VApp.Create
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
name P | xsd:string | Since vSphere API 4.0
resSpec P | ResourceConfigSpec | Since vSphere API 4.0
configSpec P | VAppConfigSpec | Since vSphere API 4.0
vmFolder* P | ManagedObjectReference to a Folder | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a VirtualApp |

Faults

Type | Description
--- | ---
DuplicateName |
InsufficientResourcesFault |
InvalidName |
InvalidState |
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

# DestroyChildren

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.

Return Value

Type | Description
--- | ---
None

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

# ImportVApp

Required Privileges
  VApp.Import
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
spec P | ImportSpec | Since vSphere API 4.0
folder* P | ManagedObjectReference to a Folder | Since vSphere API 4.0
host* P | ManagedObjectReference to a HostSystem | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a HttpNfcLease |

Faults

Type | Description
--- | ---
DuplicateName |
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidName |
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

# MoveIntoResourcePool

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
list P | ManagedObjectReference[] to a ManagedEntity[] | Since null

P Required privilege: list

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
DuplicateName |
InsufficientResourcesFault |
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

# QueryResourceConfigOption

Deprecated.

Required Privileges
  Resource.EditPool
Since
  vSphere API 4.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.

Return Value

Type | Description
--- | ---
ResourceConfigOption |

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

# RefreshRuntime

Required Privileges
  System.View
Since
  vSphere API 4.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.

Return Value

Type | Description
--- | ---
None

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

# RegisterChildVM_Task

Required Privileges
  VirtualMachine.Inventory.Register
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
path P | xsd:string | Since vSphere API 4.0
name* P | xsd:string | Since vSphere API 4.0
host* P | ManagedObjectReference to a HostSystem | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
AlreadyExists |
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidName |
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

# UpdateChildResourceConfiguration

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
spec P | ResourceConfigSpec[] | Since null

P Required privilege: spec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InsufficientResourcesFault |
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

# UpdateConfig

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ResourcePool used to make the method call.
name* P | xsd:string | Since null
config* P | ResourceConfigSpec | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
ConcurrentAccess |
DuplicateName |
InsufficientResourcesFault |
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