Search <book_title>...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2021-12-06

Product(s): Enterprise Vault (14.2)

Get-EVFSAFolder

Get-EVFSAFolder retrieves details of all folders that are set up for File System Archiving for a specified file server and volume in an Enterprise Vault site. You can filter this list based on the folder relative path to get details of a single folder.

Get-EVFSAFolder is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

Get-EVFSAFolder [-FileServer] <String> [-Volume] <String> [[-FolderRelativePath] <String>] [-SiteId <String>] [-IncludeRetentionFolders [<SwitchParameter>]] [<CommonParameters>]

Get-EVFSAFolder -Identifier <String> [-SiteId <String>] [-IncludeRetentionFolders [<SwitchParameter>]] [<CommonParameters>]

Parameters

Table: Get-EVFSAFolder parameters

Parameter	Description
-FileServer (required)	The fully-qualified DNS name, UNC name, alias name, or entry ID of the file server that hosts the folder. The name should be the same as the name that was used when you added the file server, or the name that the Administration Console displays. You can use Get-EVFSAFileServer to obtain the file server name. You can specify the UNC name with or without the \\ prefix and you can specify either the hostname or the alias as the UNC name. Parameter aliases: FileServerDNSName, FileServerName, FileServerId.
-Identifier (required)	The path of the folder that you want to retrieve details of, in the following format: \\file server name\volume name\folder relative path
-Volume (required)	The name or the entry ID of the file server volume that hosts the folder. Parameter aliases: VolumeId, VolumeName
-FolderRelativePath	The relative path of the folder that you want to retrieve details of. Specify \ if the folder target is the share. Parameter aliases: FolderName
-SiteId	The ID of the Enterprise Vault site in which the file server volume is configured. If you omit this parameter, Get-EVFSAFolder uses the ID of the site of the Enterprise Vault server where the cmdlet is running. You can use Get-EVSite to obtain the site ID.
-IncludeRetentionFolders	Specifies whether Enterprise Vault should retrieve details of all folders, including retention folders.

Examples

Get-EVFSAFolder \\abc volume1 folder1
or
Get-EVFSAFolder -FileServer \\abc -Volume volume1 -FolderRelativePath folder1
or
Get-EVFSAFolder -FileServerName \\abc -VolumeName volume1 -FolderRelativePath folder1
or
Get-EVFSAFolder -Identifier \\abc\volume1\folder1
Retrieves the details of the folder 'folder1' on the file server volume 'volume1' that is configured on the file server with the UNC path '\\abc'.
Get-EVFSAFolder abc.example.com volume1 folder1
or
Get-EVFSAFolder -FileServer abc.example.com -Volume volume1 -FolderRelativePath folder1
or
Get-EVFSAFolder -FileServerDNSName abc.example.com -VolumeName volume1 - FolderRelativePath folder1
Retrieves the details of the folder 'folder1' on the file server volume 'volume1' that is configured on the file server with the fully-qualified domain name 'abc.example.com'.
Get-EVFSAFolder -FileServer '123...example.com' -Volume 56...example.com' -FolderRelativePath folder1
or
Get-EVFSAFolder -FileServerId '123...example.com' - VolumeId '456...example.com' -FolderRelativePath folder1
or
Get-EVFSAFolder '123...example.com' '456...example.com' folder1
Retrieves the details of the folder 'folder1' on the file server volume with the entry ID '456...example.com' that is configured on the file server with the entry ID '123...example.com'.
Get-EVFSAFolder \\abc volume1 folder1 -IncludeRetentionFolders
or
Get-EVFSAFolder -FileServer \\abc -Volume volume1 -FolderRelativePath folder1 -IncludeRetentionFolders
or
Get-EVFSAFolder -FileServerName \\abc -VolumeName volume1 -FolderRelativePath folder1 -IncludeRetentionFolders
or
Get-EVFSAFolder -Identifier \\abc\volume1\folder1 -IncludeRetentionFolders
Retrieves the details of the retention folder 'folder1' on the file server volume 'volume1' that is configured on the file server with the UNC path '\\abc'.

Output

The Get-EVFSAFolder properties that are available are listed in the following table:

Table: Get-EVFSAFolder properties

Name	Type	Description
FolderPath	String	The full path of the folder that is enabled for File System Archiving. The path is in the format \\file server name\volume name\folder relative path.
FolderName	String	The relative path of the folder.
IsRetentionFolder	Boolean	Specifies whether the folder is a retention folder.
FolderPolicyName	String	The name of the folder policy that Enterprise Vault uses to archive items from the folder.
VolumePolicyName	String	The name of the volume policy that Enterprise Vault uses to archive items from the volume.
IgnoreVolumeRules	String	Specifies that Enterprise Vault should ignore volume policy rules when it archives items from the folder.
ArchivingEnabledOnFolder	Boolean	Specifies whether File System Archiving is enabled on the folder.
ArchivingEnabledOnSubfolders	Boolean	Specifies whether File System Archiving is enabled on the subfolders of the folder.
FileServerName	String	The fully-qualified DNS name of the file server that hosts the folder.
FileServerId	String	The ID of the file server that hosts the folder.
VolumeName	String	The name of the volume that hosts the folder.
VolumeId	String	The ID of the volume that hosts the folder.
FolderId	String	The ID of the folder.
FolderPolicyId	String	The ID of the folder policy that Enterprise Vault uses to archive items from the folder.
VolumePolicyId	String	The ID of the volume policy that Enterprise Vault uses to archive items from the volume.

Related cmdlets