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

Get-EVFSAFileServer

Get-EVFSAFileServer retrieves details of all the file servers that are configured in the specified Enterprise Vault site. You can filter this list based on the type of file server.

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

Syntax

Get-EVFSAFileServer [-SiteId <String>][[-Type] <FileServerType>] [<CommonParameters>]

Get-EVFSAFileServer [-SiteId <String>] [-Identifier] <String> [<CommonParameters>]

Parameters

Table: Get-EVFSAFileServer parameters

Parameter

Description

-SiteId (required)

The ID of the Enterprise Vault site in which the file server is configured. If you omit this parameter, Get-EVFSAFileServer uses the ID of the site of the Enterprise Vault server where the command is running. You can use Get-EVSite to obtain the site ID.

-Type

The file server type. Possible values are WindowsFileServer, NetApp7ModeFileServer, NetAppCModeFileServer, and EMCCelerraOrVNXFileServer.

-Identifier (required)

The fully-qualified DNS name, UNC name, or Entry ID of the file server target that is configured in the Enterprise Vault site. 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.

Parameter aliases: FileServerDNSName, FileServerName, FileServerId.

Examples
  • Get-EVFSAFileServer

    Retrieves the details of all the file servers that are set up for File System Archiving in the Enterprise Vault site.

  • Get-EVFSAFileServer -SiteId 198...example.com -Type WindowsFileServer

    Retrieves the details of all the Windows file servers that are set up for File System Archiving in the specified Enterprise Vault site.

  • Get-EVFSAFileServer -Type NetApp7ModeFileServer

    Retrieves the details of all the NetApp 7-Mode file servers that are set up for File System Archiving in the Enterprise Vault site.

  • Get-EVFSAFileServer - Identifier abc.example.com

    or

    Get-EVFSAFileServer - FileServerDNSName abc.example.com

    Retrieves the details of the file server with the fully qualified domain name 'abc.example.com' in the Enterprise Vault site.

  • Get-EVFSAFileServer -Identifier \\abc

    or

    Get-EVFSAFileServer -FileServername \\abc

    Retrieves the details of the file server with the UNC name '\\abc' configured in the Enterprise Vault site.

  • Get-EVFSAFileServer -Identifier 198...example.com

    or

    Get-EVFSAFileServer - FileServerId 198...example.com

    Retrieves the details of the file server with the Entry ID '198...example.com' configured in the Enterprise Vault site.

Output

The following tables list the properties that are available:

Table: Get-EVFSAFileServer - WindowsFileServer properties

Name

Type

Description

FileServerName

String

The UNC name of the file server that is configured in the Enterprise Vault site.

FileServerDNSName

String

The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site.

FileServerId

String

The ID of the file server that is configured in the Enterprise Vault site.

FileServerType

FileServerType

The type of file server. In this case the value is WindowsFileServer.

Archiving

Boolean

Specifies whether File System Archiving is enabled for this server.

SiteId

String

The ID of the Enterprise Vault site in which the file server is configured.

PassthroughRecall

Boolean

Specifies if pass-through recall is configured.

PassthroughRecallCacheLocation

String

Specifies the pass-through recall cache location.

PassthroughRecallCacheSizeInGB

Integer

Specifies the pass-through recall cache location size in gigabytes.

ActionOnPlaceholderDelete

ActionOnPlaceholderDelete

Specifies whether to retain or delete an archived file when its placeholder is deleted. Values can be RetainArchivedFile or DeleteArchivedFile.

Table: Get-EVFSAFileServer - NetAppCModeFileServer properties

Name

Type

Description

FileServerName

String

The UNC name of the file server that is configured in the Enterprise Vault site.

FileServerDNSName

String

The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site.

FileServerId

String

The ID of the file server that is configured in the Enterprise Vault site.

FileServerType

FileServerType

The type of file server. In this case the value is NetAppCModeFileServer.

Archiving

Boolean

Specifies whether File System Archiving is enabled for this server.

SiteId

String

The ID of the Enterprise Vault site in which the file server is configured.

ActionOnPlaceholderDelete

ActionOnPlaceholderDelete

Specifies whether to retain or delete an archived file when its placeholder is deleted. Values can be RetainArchivedFile or DeleteArchivedFile.

PlaceholderRecallsEnabled

Boolean

Specifies whether the processing of placeholder recalls for the NetApp filer is enabled.

MaxRecallThreads

Integer

The maximum number of recall threads to be used when you recall items. This value is equivalent to the number of simultaneous recalls.

RecallLimitMaxRecalls

Integer

Specifies the maximum number of items that a user is allowed to recall.

RecallLimitTimeInterval

Integer

Specifies the maximum number of items that a user is allowed to recall in the specified time period.

IgnoreRecallLimitForLocalAdministrators

Boolean

Specifies whether the recall limits apply to members of the local Administrators group for the NetApp filer.

Table: Get-EVFSAFileServer - NetApp7ModeFileServer properties

Name

Type

Description

FileServerName

String

The UNC name of the file server that is configured in the Enterprise Vault site.

FileServerDNSName

String

The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site.

FileServerId

String

The ID of the file server that is configured in the Enterprise Vault site.

FileServerType

FileServerType

The type of file server. In this case the value is NetApp7ModeFileServer.

Archiving

Boolean

Specifies whether File System Archiving is enabled for this server.

SiteId

String

The ID of the Enterprise Vault site in which the file server is configured.

ActionOnPlaceholderDelete

ActionOnPlaceholderDelete

Specifies whether to retain or delete an archived file when its placeholder is deleted. Values can be RetainArchivedFile or DeleteArchivedFile.

PassthroughRecall

Boolean

Specifies if pass-through recall is configured.

PlaceholderRecallsEnabled

Boolean

Specifies whether the processing of placeholder recalls for the NetApp filer is enabled.

MaxRecallThreads

Integer

The maximum number of recall threads to be used when you recall items. This value is equivalent to the number of simultaneous recalls.

RecallLimitMaxRecalls

Integer

Specifies the maximum number of items that a user is allowed to recall.

RecallLimitTimeInterval

Integer

Specifies the maximum number of items that a user is allowed to recall in the specified time period.

IgnoreRecallLimitForLocalAdministrators

Boolean

Specifies whether the recall limits apply to members of the local Administrators group for the NetApp filer.

Table: Get-EVFSAFileServer - EMCCelerraOrVNXFileServer properties

Name

Type

Description

FileServerName

String

The UNC name of the file server that is configured in the Enterprise Vault site.

FileServerDNSName

String

The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site.

FileServerId

String

The ID of the file server that is configured in the Enterprise Vault site.

FileServerType

FileServerType

The type of file server. For Celerra or VNX the value is EMCCelerraOrVNXFileServer.

Archiving

Boolean

Specifies whether File System Archiving is enabled for this server.

SiteId

String

The ID of the Enterprise Vault site in which the file server is configured.

PlaceholdersEnabled

Boolean

Specifies whether placeholders are created on the share for the file server if the policy is enabled to create shortcuts.

DHSMServiceConfiguration

DHSMServiceConfiguration

Specifies the DHSM service configuration that is required for placeholder creation.

Table: Get-EVFSAFileServer - DHSMServiceConfiguration properties

Name

Type

Description

UserName

String

Specifies the Data Mover user name with which Enterprise Vault authenticates the DHSM service.

Password

SecureString

Specifies the password for the Data Mover account with which Enterprise Vault authenticates the DHSM service. This password is stored in an encrypted format in the Enterprise Vault Directory database.

PortNumber

Integer

Specifies the port number on which the DHSM is configured.

SSLRequired

Boolean

Specifies whether the DHSM service requires SSL connections.

Related cmdlets