Managed Object - Folder

Property of
ConverterAgentInternalManagedVMOptions, ConverterTargetVmSpecManagedVmLocation, Datacenter, FolderEventArgument, HostConnectSpec, NodeDeploymentSpec, ServiceContent, StoragePlacementSpec, VAppCloneSpec, VirtualApp, VirtualMachineRelocateSpec
Parameter to
CheckClone_Task, CloneVM_Task, CreateVApp, ImportVApp
Returned by
CreateFolder
Extended by
StoragePod
Extends
ManagedEntity
See also
ClusterComputeResource, ClusterConfigSpec, ClusterConfigSpecEx, ComputeResource, ComputeResourceConfigSpec, Datacenter, DistributedVirtualSwitch, DVSCreateSpec, FolderBatchAddHostsToClusterResult, FolderBatchAddStandaloneHostsResult, FolderNewHostSpec, HostConnectSpec, HostSystem, ManagedEntity, ResourcePool, StoragePod, VirtualMachine, VirtualMachineConfigSpec
Since
null


Managed Object Description

Properties

Name Type Description
childEntity* PManagedObjectReference[]
to a ManagedEntity[]


childType* Pxsd:string[]


namespace* Pxsd: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
*May not be presentP Required privilege: System.View

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

AddStandaloneHost_Task

Required Privileges
Host.Inventory.AddStandaloneHost

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Folder used to make the method call.
spec PHostConnectSpec

Since null
compResSpec* PComputeResourceConfigSpec

Since null
addConnected Pxsd:boolean

Since null
license* Pxsd:string

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
DuplicateName
HostConnectFault
InvalidLogin
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



BatchAddHostsToCluster_Task

Required Privileges
None
Since
vSphere API 6.7.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Folder used to make the method call.
cluster PManagedObjectReference
to a ClusterComputeResource

Since vSphere API 6.7.1
newHosts* PFolderNewHostSpec[]

Since vSphere API 6.7.1
existingHosts* PManagedObjectReference[]
to a HostSystem[]

Since vSphere API 6.7.1
compResSpec* PComputeResourceConfigSpec

Since vSphere API 6.7.1
desiredState* Pxsd:string

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



BatchAddStandaloneHosts_Task

Required Privileges
Host.Inventory.AddStandaloneHost
Since
vSphere API 6.7.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Folder used to make the method call.
newHosts* PFolderNewHostSpec[]

Since vSphere API 6.7.1
compResSpec* PComputeResourceConfigSpec

Since vSphere API 6.7.1
addConnected Pxsd:boolean

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



CreateCluster

Deprecated.

Required Privileges
Host.Inventory.CreateCluster

Parameters

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

Since null
spec PClusterConfigSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ClusterComputeResource

Faults

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



CreateClusterEx

Required Privileges
Host.Inventory.CreateCluster
Since
VI API 2.5

Parameters

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

Since VI API 2.5
spec PClusterConfigSpecEx

Since VI API 2.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ClusterComputeResource

Faults

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



CreateDatacenter

Required Privileges
Datacenter.Create

Parameters

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

Since null
P Required privilege: name

Return Value

Type Description
ManagedObjectReference
to a Datacenter

Faults

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



CreateDVS_Task

Required Privileges
DVSwitch.Create
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Folder used to make the method call.
spec PDVSCreateSpec

Since vSphere API 4.0
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
DuplicateName
DvsFault
DvsNotAuthorized
InvalidName
NotFound
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



CreateFolder

Required Privileges
Folder.Create

Parameters

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

Since null
P Required privilege: name

Return Value

Type Description
ManagedObjectReference
to a Folder

Faults

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



CreateStoragePod

Required Privileges
Folder.Create
Since
vSphere API 5.0

Parameters

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

Since vSphere API 5.0
P Required privilege: name

Return Value

Type Description
ManagedObjectReference
to a StoragePod

Faults

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



CreateVM_Task

Required Privileges
VirtualMachine.Inventory.Create

Parameters

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

Since null
pool PManagedObjectReference
to a ResourcePool

Since null
host* PManagedObjectReference
to a HostSystem

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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



MoveIntoFolder_Task

Required Privileges
None

Parameters

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

Since null
P Required privilege: list

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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



RegisterVM_Task

Required Privileges
VirtualMachine.Inventory.Register

Parameters

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

Since null
name* Pxsd:string

Since null
asTemplate Pxsd:boolean

Since null
pool* PManagedObjectReference
to a ResourcePool

Since null
host* PManagedObjectReference
to a HostSystem

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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



UnregisterAndDestroy_Task

Required Privileges
Folder.Delete

Parameters

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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