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]

Parameters

Required Parameter Name Type Position Features Description
optional
Location
VIContainer[] named
  • wildcards
  • pipeline
  • Specifies vSphere container objects (folders or datacenters) you want to search for folders.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the folders you want to retrieve.
    optional
    NoRecursion
    SwitchParameter named Indicates that you want to disable the recursive behavior of the command.
    optional
    Server
    VIServer[] named
  • wildcards
  • 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
    Tag[] named Returns only the folders that are associated with any of the specified tags.
    optional
    Type
    FolderType[] named Specifies the type of the folders you want to retrieve. The valid values are VM, HostAndCluster, Datastore, Network, and Datacenter.

    -Id  <String[]>
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named
  • wildcards
  • Specifies the IDs of the folders you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • 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.

    -RelatedObject  <FolderRelatedObjectBase[]>
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    RelatedObject
    FolderRelatedObjectBase[] named
  • pipeline
  • 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

    Feedback

    Was this page helpful?