vSphere PowerCLI Reference

Get-Folder

Synopsis

Retrieves the folders available on a vSphere server.

Syntax

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

Related Commands

Online version
New-Folder
Remove-Folder
Set-Folder
Move-Folder

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.

Parameters

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

Folder

Notes

Examples

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

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

Retrieves the folder named Folder on the server with IP address 10.23.112.235.

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

Get-Folder -NoRecursion

Retrieves the root folder.


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