# 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* 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

*May not be present P 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

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

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

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

# BatchAddHostsToCluster_Task

Required Privileges
  None
Since
  vSphere API 6.7.1

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

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

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

# BatchAddStandaloneHosts_Task

Required Privileges
  Host.Inventory.AddStandaloneHost
Since
  vSphere API 6.7.1

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

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

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

# CreateCluster

Deprecated.

Required Privileges
  Host.Inventory.CreateCluster

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

P Required privilege - see tooltip for details

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

# CreateClusterEx

Required Privileges
  Host.Inventory.CreateCluster
Since
  VI API 2.5

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

P Required privilege - see tooltip for details

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

# CreateDatacenter

Required Privileges
  Datacenter.Create

Parameters

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

P Required privilege: name

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

# CreateDVS_Task

Required Privileges
  DVSwitch.Create
Since
  vSphere API 4.0

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

P Required privilege: spec

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

# CreateFolder

Required Privileges
  Folder.Create

Parameters

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

P Required privilege: name

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

# CreateStoragePod

Required Privileges
  Folder.Create
Since
  vSphere API 5.0

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

P Required privilege: name

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

# CreateVM_Task

Required Privileges
  VirtualMachine.Inventory.Create

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

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

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

# MoveIntoFolder_Task

Required Privileges
  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

P Required privilege: list

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

# RegisterVM_Task

Required Privileges
  VirtualMachine.Inventory.Register

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

*Need not be set P Required 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 |
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

# UnregisterAndDestroy_Task

Required Privileges
  Folder.Delete

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