vSphere PowerCLI Reference



Retrieves the folders available on a vSphere server.


Get-Folder [-Location <VIContainer[]>] [-Type <FolderType[]>] [[-Name] <String[]>] [-Id <String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version

Detailed Description

Retrieves the folders available on a vSphere server. The cmdlet returns a set of folders that correspond to the filter criteria provided by the cmdlet parameters. To specify a server different from the default one, use the -Server parameter.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specify the names of the folders you want to retrieve.falsefalse
IdString[]Specify the IDs of the folders you want to retrieve.falsefalse
LocationVIContainer[]Specify vSphere container objects (folders, datacenters, or clusters) you want to search for folders.falsetrue (ByValue)
NoRecursionSwitchParameterIndicate that you want to disable the recursive behavior of the command.falsefalse
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
TypeFolderType[]Specify the type of the folders you want to retrieve. The valid values are VM, HostAndCluster, Datastore, Network, and Datacenter.falsefalse

Return Type




-------------- Example 1 --------------

$server = Connect-VIServer -Server
Get-Folder -Server $server -Name Folder

Retrieves the folder named Folder on the server with IP address

-------------- Example 2 --------------

Get-Folder -NoRecursion

Retrieves the root folder.

-------------- Example 3 --------------

Get-Folder -Location $folder

Gets all folders in the specified location.

-------------- Example 4 --------------

$folder = Get-Folder | Select -first 1 

Get-Folder -ID $folder.ID

Gets a folder by ID.

-------------- Example 5 --------------

Get-Folder -Type Network

Gets all network folders.

Copyright © 1998 - 2012 VMware, Inc. All rights reserved.