Get-Folder
This cmdlet retrieves the folders available on a vCenter Server system. 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.
Syntax
[-Location
<VIContainer[]>]
[-Name <String[]>]
[-NoRecursion]
[-Server <VIServer[]>]
[-Tag <Tag[]>]
[-Type <FolderType[]>]
[CommonParameters]
[-Name <String[]>]
[-NoRecursion]
[-Server <VIServer[]>]
[-Tag <Tag[]>]
[-Type <FolderType[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
VIContainer[] | named |
|
Specifies vSphere container objects (folders or datacenters) you want to search for folders. | optional |
|
String[] | named |
|
Specifies the names of the folders you want to retrieve. | optional |
|
SwitchParameter | named |
|
Indicates that you want to deactivate the recursive behavior of the command. | optional |
|
VIServer[] | named |
|
Specifies the vSphere servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | optional |
|
Tag[] | named |
|
Returns only the folders that are associated with any of the specified tags. | optional |
|
FolderType[] | named |
|
Specifies the type of the folders you want to retrieve. The valid values are VM, HostAndCluster, Datastore, Network, and Datacenter. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Specifies the IDs of the folders you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | optional |
|
VIServer[] | named |
|
Specifies the vSphere servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
FolderRelatedObjectBase[] | named |
|
Specifies objects to retrieve one or more Folder objects that are related to them. This parameter accepts OMResource objects. |
Output
VMware.VimAutomation.ViCore.Types.V1.Inventory.Folder
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.
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.
Related Commands
Folder
This cmdlet retrieves the folders available on a vCenter Server system.
This cmdlet moves a vCenter Server folder from one location to another.
This cmdlet modifies the properties of the specified folder.
This cmdlet removes the specified folders from their locations.
This cmdlet creates a new folder on a vCenter Server system.
