Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.4)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      About the Enterprise Vault Management Shell
    2.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    3.  
      Rules for PowerShell strings
    4. 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-EVFSAComputerSettings
    2.  
      Get-EVFSAFileServer
    3.  
      Get-EVFSAFolder
    4.  
      Get-EVFSASiteSettings
    5.  
      Get-EVFSAVolume
    6.  
      New-EVFSAFileServer
    7.  
      New-EVFSAFolder
    8.  
      New-EVFSAVolume
    9.  
      Remove-EVFSAFileServer
    10.  
      Remove-EVFSAFolder
    11.  
      Remove-EVFSAVolume
    12.  
      Set-EVFSAComputerSettings
    13.  
      Set-EVFSAFileServer
    14.  
      Set-EVFSAFolder
    15.  
      Set-EVFSASiteSettings
    16.  
      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-EVArchivePermission
    4.  
      Get-EVVaultStore
    5.  
      Get-EVVaultStorePartition
    6.  
      Remove-EVArchive
    7.  
      Remove-EVArchivePermission
    8.  
      Set-EVArchive
    9.  
      Set-EVArchivePermission
    10.  
      Start-PartitionRollover

Get-EVFSAVolume

Get-EVFSAVolume retrieves details of all the volumes set up for File System Archiving in an Enterprise Vault site. This list can be filtered based on a file server and a volume name.

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

Syntax

Get-EVFSAVolume [-SiteId <String>] [<CommonParameters>]

Get-EVFSAVolume [-SiteId <String>] [-FileServerName] <String> [[-Name] <String>] [<CommonParameters>]

Get-EVFSAVolume [-SiteId <String>] -FileServerId <String> [[-Name] <String>] [<CommonParameters>]

Parameters

Table: Get-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, Get-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.

-FileServerName (required)

The fully-qualified DNS name or the alias of the file server target configured under the Enterprise Vault site, which hosts the volume share.

-FileServerId (required)

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

-Name

The name of a share folder added as an FSA volume.

Examples

  • Get-EVFSAVolume - SiteId 198…example.com

    Retrieves all the volumes hosted on all the file servers in the specified Enterprise Vault site.

  • Get-EVFSAVolume - SiteId 198…example.com -FileServerId 1FB…example.com

    Retrieves all the volumes hosted on the file server with ID '1FB…example.com'.

  • Get-EVFSAVolume - SiteId 198…example.com -FileServerId 1FB…example.com -Name Sales

    Retrieves the properties of the volume 'Sales' hosted on the file server with ID '1FB…example.com'.

  • Get-EVFSAVolume - SiteId 198…example.com -FileServerName 'WindowsFiler.example.com'

    Retrieves all the volumes hosted on the file server with the name 'WindowsFiler.example.com'.

  • Get-EVFSAVolume - SiteId 198…example.com - FileServerName \\WindowsFiler

    Retrieves all the volumes hosted on the file server with the name '\\WindowsFiler'.

  • Get-EVFSAVolume - SiteId 198…example.com -FileServerName 'WindowsFiler.example.com' -Name Marketing

    Retrieves the properties of the volume 'Marketing' hosted on the file server with the name 'WindowsFiler.example.com'.

Output

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

Table: Get-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