Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.2)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      About the Enterprise Vault Management Shell
    2.  
      Importing modules
    3.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    4.  
      Rules for PowerShell strings
    5. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Archiving: Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Get-EVExchangeMailboxPolicy
    4.  
      New-EVExchangeMailboxPolicy
    5.  
      Remove-EVExchangeFolderPolicy
    6.  
      Remove-EVExchangeMailboxPolicy
    7.  
      Set-EVExchangeMailboxPolicy
  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: Skype for Business
    1.  
      Get-EVSkypeForBusinessTarget
    2.  
      New-EVSkypeForBusinessTarget
    3.  
      Remove-EVSkypeForBusinessTarget
    4.  
      Set-EVSkypeForBusinessTarget
  5. Archiving: SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPMessageTrackingLogLocation
    3.  
      Get-EVSMTPPolicy
    4.  
      Get-EVSMTPServerSettings
    5.  
      Get-EVSMTPTarget
    6.  
      New-EVSMTPPolicy
    7.  
      New-EVSMTPServerSettings
    8.  
      New-EVSMTPTarget
    9.  
      Remove-EVSMTPPolicy
    10.  
      Remove-EVSMTPTarget
    11.  
      Set-EVSMTPMessageTrackingLogLocation
    12.  
      Set-EVSMTPPolicy
    13.  
      Set-EVSMTPServerSettings
    14.  
      Set-EVSMTPTarget
    15.  
      Sync-EVSMTPServerSettings
  6. Backup
    1.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  7. Classification
    1.  
      Disable-EVClassification
    2.  
      Get-EVClassificationFCITags
    3.  
      Get-EVClassificationPolicy
    4.  
      Get-EVClassificationStatus
    5.  
      Get-EVClassificationTestMode
    6.  
      Get-EVClassificationVICTags
    7.  
      Import-EVClassificationFCIRules
    8.  
      Initialize-EVClassificationVIC
    9.  
      New-EVClassificationPolicy
    10.  
      Publish-EVClassificationFCIRules
    11.  
      Remove-EVClassificationPolicy
    12.  
      Set-EVClassificationPolicy
    13.  
      Set-EVClassificationTestMode
  8. Databases
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  9. IMAP access
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  10. Indexing
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
  11. Records management
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  12. Retention plans
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  13. Roles-based administration
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  14. Sites and servers
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
    6.  
      Get-EVSiteInfo
  15. Tasks and services
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  16. Vault stores and archives
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Set-EVArchive
    6.  
      Start-PartitionRollover

New-EVFSAVolume

New-EVFSAVolume helps to set up File System Archiving for a volume on the selected file server. If the share you want to add is defined as a safety folder, then archived items will not be deleted when placeholders are deleted. For Celerra shares, if the volume policy has both pass-through and Delete archived file when placeholder is deleted enabled, then you are prompted to confirm the action because it can lead to data loss.

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

Syntax

New-EVFSAVolume [-SiteId <String>] [-Name] <String> [-FileServerName] <String> [-VaultStoreName] <String> [-TaskName] <String> [-PolicyName] <String> [-DisableArchiving [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

New-EVFSAVolume [-SiteId <String>] [-Name] <String> -FileServerId <String> -VaultStoreId <String> -TaskId <String> -PolicyId <String> [-DisableArchiving [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Parameters

Table: New-EVFSAVolume parameters

Parameter

Description

-SiteId (required)

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

-Name (required)

The name of the share that you want to configure as a volume target

-FileServerName (required)

The name of the file server whose volume you want to retrieve.

-FileServerId (required)

The ID of the file server whose volume you want to retrieve.

-VaultStoreName (required)

The name of the vault store that you want to use for archiving files from the new volume.

VaultStoreId (required)

The ID of the vault store that you want to use for archiving files from the new volume.

-TaskName (required)

The name of the File System Archiving task that you want to use for this volume. The task should exist on the same computer as that of the vault store.

-TaskId (required)

The ID of the File System Archiving task that you want to use for this volume. The task should exist on the same computer as that of the vault store.

-PolicyName (required)

The name of the FSA volume policy that you want to use for the new volume.

-PolicyId (required)

The ID of the FSA volume policy that you want to use for the new volume.

-DisableArchiving

If specified, disables file archiving from this volume.

Examples

  • New-EVFSAVolume - SiteId 198…example.com -Name Sales -FileServerId 1FB…example.com -PolicyId 10C…example.com -VaultStoreId 1AC…example.com -TaskId 120…example.com

    Adds the existing share 'Sales' as a volume for archiving on the file server with ID '1FB…example.com', with the specified properties.

  • New-EVFSAVolume - SiteId 198…example.com -Name Marketing -FileServerId 1FB…example.com -PolicyId 10C…example.com -VaultStoreId 1AC…example.com -TaskId 120…example.com -DisableArchiving

    Adds the existing share 'Marketing' as a volume on the file server with ID '1FB…example.com', with the specified properties and prevents archiving from the volume.

  • New-EVFSAVolume - SiteId 198…example.com -Name Finance -FileServerName WindowsFiler.example.com -PolicyName 'FSA Volume Policy' -VaultStoreName VSForShares -TaskName 'File System Archiving Task'

    Adds the existing share 'Finance' as a volume for archiving on the file server with the fully-qualified DNS name 'WindowsFiler.example.com', with the specified properties.

  • New-EVFSAVolume - SiteId 198…example.com -Name HumanResources -FileServerName \\WindowsFiler -PolicyName 'FSA Volume Policy' -VaultStoreName VSForShares -TaskName 'File System Archiving Task'

    Adds the existing share 'HumanResources' as a volume for archiving on the file server with the alias '\\WindowsFiler', with the specified properties.

Output

Table: New-EVFSAVolume properties lists the properties that are available.

Table: New-EVFSAVolume properties

Name

Type

Description

VolumeName

String

The name of the FSA volume.

VolumeId

String

The ID of the FSA volume.

FileServerName

String

The name of the file server that hosts the volume as configured in the Enterprise Vault Site.

FileServerId

String

The ID of the file server that hosts the volume share.

VaultStoreName

String

The name of the vault store that is used to store files archived from this volume.

VaultStoreId

String

The ID of the vault store that is used to store files archived from this volume.

TaskName

String

The name of the File System Archiving task that is used to process this volume.

TaskId

String

The ID of the File System Archiving task that is used to process this volume.

PolicyName

String

The name of the file system archiving volume policy that is used when archiving from this volume.

PolicyId

String

The ID of the file system archiving policy that is used when archiving from this volume.

DisableArchiving

SwitchParameter

Specifies whether file archiving from this volume is disabled.

PassthroughRecall

SwitchParameter

Specifies whether pass-through recall for this volume is enabled.

SiteId

String

The ID of the Enterprise Vault site under which the volume is configured.

Related cmdlets