< Back
Get-Folder
Post
NAME Get-Folder
SYNOPSIS
This cmdlet retrieves the folders available on a vCenter Server system.
SYNTAX
Get-Folder -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
Get-Folder [[-Name] <String[]>] [-Location <VIContainer[]>] [-NoRecursion] [-Server <VIServer[]>] [-Tag <Tag[]>]
[-Type <FolderType[]>] [<CommonParameters>]
Get-Folder [-RelatedObject] <FolderRelatedObjectBase[]> [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Id <String[]>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Location <VIContainer[]>
Specifies vSphere container objects (folders or datacenters) you want to search for folders.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the folders you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-NoRecursion [<SwitchParameter>]
Indicates that you want to disable the recursive behavior of the command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RelatedObject <FolderRelatedObjectBase[]>
Specifies objects to retrieve one or more Folder objects that are related to them. This parameter accepts
OMResource objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Server <VIServer[]>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Tag <Tag[]>
Returns only the folders that are associated with any of the specified tags.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Type <FolderType[]>
Specifies the type of the folders you want to retrieve. The valid values are VM, HostAndCluster, Datastore,
Network, and Datacenter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more Folder objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... older.html
New-Folder
Remove-Folder
Set-Folder
Move-Folder
SYNOPSIS
This cmdlet retrieves the folders available on a vCenter Server system.
SYNTAX
Get-Folder -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
Get-Folder [[-Name] <String[]>] [-Location <VIContainer[]>] [-NoRecursion] [-Server <VIServer[]>] [-Tag <Tag[]>]
[-Type <FolderType[]>] [<CommonParameters>]
Get-Folder [-RelatedObject] <FolderRelatedObjectBase[]> [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-Id <String[]>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Location <VIContainer[]>
Specifies vSphere container objects (folders or datacenters) you want to search for folders.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the folders you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-NoRecursion [<SwitchParameter>]
Indicates that you want to disable the recursive behavior of the command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RelatedObject <FolderRelatedObjectBase[]>
Specifies objects to retrieve one or more Folder objects that are related to them. This parameter accepts
OMResource objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Server <VIServer[]>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Tag <Tag[]>
Returns only the folders that are associated with any of the specified tags.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Type <FolderType[]>
Specifies the type of the folders you want to retrieve. The valid values are VM, HostAndCluster, Datastore,
Network, and Datacenter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more Folder objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... older.html
New-Folder
Remove-Folder
Set-Folder
Move-Folder