Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.1)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      What's new in Enterprise Vault 12.1
    2.  
      About the Enterprise Vault Management Shell
    3.  
      Importing modules
    4.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    5.  
      Rules for PowerShell strings
    6. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Archiving: Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Remove-EVExchangeFolderPolicy
  3. Archiving: FSA
    1.  
      Get-EVFSAFileServer
    2.  
      Get-EVFSAFolder
    3.  
      Get-EVFSAVolume
    4.  
      New-EVFSAFileServer
    5.  
      New-EVFSAFolder
    6.  
      New-EVFSAVolume
    7.  
      Remove-EVFSAFileServer
    8.  
      Remove-EVFSAFolder
    9.  
      Remove-EVFSAVolume
    10.  
      Set-EVFSAFileServer
    11.  
      Set-EVFSAFolder
    12.  
      Set-EVFSAVolume
  4. Archiving: SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPPolicy
    3.  
      Get-EVSMTPServerSettings
    4.  
      Get-EVSMTPTarget
    5.  
      New-EVSMTPPolicy
    6.  
      New-EVSMTPServerSettings
    7.  
      New-EVSMTPTarget
    8.  
      Remove-EVSMTPPolicy
    9.  
      Remove-EVSMTPTarget
    10.  
      Set-EVSMTPPolicy
    11.  
      Set-EVSMTPServerSettings
    12.  
      Set-EVSMTPTarget
    13.  
      Sync-EVSMTPServerSettings
  5. Backup
    1.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  6. Classification
    1.  
      Get-EVClassificationPolicy
    2.  
      Get-EVClassificationTags
    3.  
      Get-EVClassificationTestMode
    4.  
      Import-EVClassificationRules
    5.  
      New-EVClassificationPolicy
    6.  
      Publish-EVClassificationRules
    7.  
      Remove-EVClassificationPolicy
    8.  
      Set-EVClassificationPolicy
    9.  
      Set-EVClassificationTestMode
  7. Databases
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  8. IMAP access
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  9. Indexing
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
  10. Records management
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  11. Retention plans
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  12. Roles-based administration
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  13. Sites and servers
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
  14. Tasks and services
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  15. Vault stores and archives
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Set-EVArchive
    6.  
      Start-PartitionRollover

Set-EVFSAFolder

Set-EVFSAFolder updates the specified settings of an existing folder.

Set-EVFSAFolder is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

Set-EVFSAFolder [-SiteId <String>] [-FileServer] <String> [-Volume] <String> [-FolderRelativePath] <String> [-Policy <String>] [-IgnoreVolumeRules [<SwitchParameter>]] [-UseVolumePolicy [<SwitchParameter>]] [-DisableArchivingOnFolder [<SwitchParameter>]] [-DisableArchivingOnSubFolders [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Set-EVFSAFolder [-SiteId <String>] -Identifier <String> [-Policy <String>] [-IgnoreVolumeRules [<SwitchParameter>]] [-UseVolumePolicy [<SwitchParameter>]] [-DisableArchivingOnFolder [<SwitchParameter>]] [-DisableArchivingOnSubFolders [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Set-EVFSAFolder [-SiteId <String>] [-FsaFolder] <FSAFolder> [-Policy <String>] [-IgnoreVolumeRules [<SwitchParameter>]] [-UseVolumePolicy [<SwitchParameter>]] [-DisableArchivingOnFolder [<SwitchParameter>]] [-DisableArchivingOnSubFolders [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Parameters

Table: Set-EVFSAFolder parameters

Parameter

Description

-SiteId (required)

The ID of the Enterprise Vault site in which the file server volume is configured. If you omit this parameter, Set-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.

-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 update, in the following format:

\\file server name\volume name\folder relative path

-FsaFolder (required)

Specifies the FSAFolder object. Note that the cmdlet uses the FileServerName, VolumeName, and FolderName properties from the specified object to identify the folder target. You must also specify the parameters that you want to update.

-Volume (required)

The name or the entry ID of the file server volume that hosts the folder.

Parameter aliases: VolumeId, VolumeName

-FolderRelativePath (required)

The relative path of the folder that you want to update.

Parameter alias: FolderName

-Policy

The name or the entry ID of the folder policy that Enterprise Vault should use to archive items from the folder. You are prompted for confirmation if the specified folder is on an EMC Celerra/VNX file server and the policy has the Delete archived item when placeholder is deleted setting enabled.

Parameter aliases: PolicyId, PolicyName

-IgnoreVolumeRules

Specifies that Enterprise Vault should ignore volume policy rules when it archives the folder. This option is not available if you have not specified a folder policy.

-UseVolumePolicy

Specifies that Enterprise Vault should use the volume policy to archive items from the folder. You cannot specify both the -UseVolumePolicy and -Policy parameters.

-DisableArchivingOnFolder

Disables File System Archiving on the specified folder.

-DisableArchivingOnSubFolders

Disables File System Archiving on the subfolders of the specified folder.

-Confirm

Prompts you for confirmation before running the cmdlet. You can use this to suppress the confirmation prompt that appears when this cmdlet is run for a folder on an EMC Celerra/VNX file server. To suppress the prompt, type -Confirm:$false.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not actually run.

Examples

  • Set-EVFSAFolder \\abc volume1 folder1 -Policy 'office files'

    or

    Set-EVFSAFolder -FileServer \\abc -Volume volume1 -FolderRelativePath folder1 -Policy 'office files'

    or

    Set-EVFSAFolder -FileServerName \\abc -VolumeName volume1 -FolderRelativePath folder1 -Policy 'office files'

    or

    Set-EVFSAFolder -Identifier \\abc\volume1\folder1 -Policy 'office files'

    or

    Set-EVFSAFolder -FolderPath \\abc\volume1\folder1 -Policy 'office files'

    Applies the 'office files' folder policy to the folder 'folder1' on the file server volume 'volume1' that is configured on the file server with the UNC name '\\abc'.

  • Set-EVFSAFolder '123...example.com' '456...example.com' folder1 -Policy '789...example.com' -DisableArchivingOnFolder -DisableArchivingOnSubFolders -IgnoreVolumeRules

    or

    Set-EVFSAFolder -FileServer '123...example.com' -Volume '456...example.com' -FolderRelativePath folder1 -Policy '789...example.com' -DisableArchivingOnFolder -DisableArchivingOnSubFolders - IgnoreVolumeRules

    or

    Set-EVFSAFolder -FileServerId '123...example.com' -VolumeId '456...example.com' -FolderRelativePath folder1 -PolicyId '789...example.com' -DisableArchivingOnFolder -DisableArchivingOnSubFolders -IgnoreVolumeRules

    Applies the folder policy with entry ID '789...example.com' to 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'. This command also disables archiving on the specified folder and its subfolders, and ignores volume policy rules when it archives the folder.

  • Set-EVFSAFolder abc.example.com volume1 folder1 - UseVolumepolicy

    or

    Set-EVFSAFolder -FileServer abc.example.com -Volume volume1 -FolderRelativePath folder1 - UseVolumepolicy

    or

    Set-EVFSAFolder -FileServerDNSName abc.example.com -VolumeName volume1 -FolderRelativePath folder1 - UseVolumepolicy

    or

    Set-EVFSAFolder -FolderPath \\abc.example.com\volume1\folder1 -UseVolumepolicy

    Applies the volume policy on 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'.

  • Set-EVFSAFolder -FsaFolder $obj -UseVolumepolicy

    Applies the volume policy on the folder that is identified by using the input FsaFolder object.

    Note:

    To create the FsaFolder object, run the following command: $obj = Get-EVFSAFolder -Identifier \\abc.example.com\volume1\folder1

  • Get-EVFSAFolder - Identifier \\abc.example.com\volume1\folder1 | Set-EVFSAFolder -UseVolumepolicy

    Pipes the FsaFolder object that is obtained from the Get-EVFSAFolder cmdlet to the Set-EVFSAFolder cmdlet and applies the volume policy on the folder.

Output

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

Table: Set-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.

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.