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[]


configResourceConfigSpec


namespace* Pxsd:string

Since vSphere API 7.0
owner PManagedObjectReference
to a ComputeResource


resourcePool* PManagedObjectReference[]
to a ResourcePool[]


runtimeResourcePoolRuntimeInfo


summaryResourcePoolSummary


vm* PManagedObjectReference[]
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 presentP 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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
config PVirtualMachineConfigSpec

Since vSphere API 4.0
host* PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
name Pxsd:string

Since null
spec PResourceConfigSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ResourcePool

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
name Pxsd:string

Since vSphere API 4.0
resSpec PResourceConfigSpec

Since vSphere API 4.0
configSpec PVAppConfigSpec

Since vSphere API 4.0
vmFolder* PManagedObjectReference
to a Folder

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a VirtualApp

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.

Return Value

Type Description
None

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
spec PImportSpec

Since vSphere API 4.0
folder* PManagedObjectReference
to a Folder

Since vSphere API 4.0
host* PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a HttpNfcLease

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
list PManagedObjectReference[]
to a ManagedEntity[]

Since null
P Required privilege: list

Return Value

Type Description
None

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.

Return Value

Type Description
ResourceConfigOption

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.

Return Value

Type Description
None

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
path Pxsd:string

Since vSphere API 4.0
name* Pxsd:string

Since vSphere API 4.0
host* PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
spec PResourceConfigSpec[]

Since null
P Required privilege: spec

Return Value

Type Description
None

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the ResourcePool used to make the method call.
name* Pxsd:string

Since null
config* PResourceConfigSpec

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
ConcurrentAccess
DuplicateName
InsufficientResourcesFault
InvalidName
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None