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-EVFSAFileServer

Set-EVFSAFileServer updates the specified settings of an existing file server that is added as a File System Archiving target. You can specify the file server using -Identifier or -FileServer.

The cmdlet has various optional parameters with which you can update different file servers.

  • For Windows file servers, you can use -EnableArchiving, -ActionOnPlaceholderDelete, -EnablePassthroughRecall, -PassthroughRecallCacheLocation, and -PassthroughRecallCacheSizeInGB.

  • For NetApp 7-mode file servers, you can use -EnableArchiving, -EnablePassthroughRecall, -ActionOnPlaceholderDelete, -EnablePlaceholderRecalls, -MaxRecallThreads, -RecallLimitMaxRecalls, -RecallLimitTimeInterval, and -IgnoreRecallLimitForLocalAdministrators.

  • For C-Mode file servers, you can use -EnableArchiving, -ActionOnPlaceholderDelete, -EnablePlaceholderRecalls, -MaxRecallThreads, -RecallLimitMaxRecalls, -RecallLimitTimeInterval, and -IgnoreRecallLimitForLocalAdministrators.

  • For Celerra/VNX file servers, you can use -EnableArchiving, -UsePlaceholderShortcuts, -DataMoverAccountDetails, -PortNumber, and -SSLRequired.

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

Syntax

Set-EVFSAFileServer [-SiteId <String>] [-Identifier] <String> [-EnableArchiving [<SwitchParameter>]] [-ActionOnPlaceholderDelete {RetainArchivedFile | DeleteArchivedFile}] [-EnablePassthroughRecall [<SwitchParameter>]] [-PassthroughRecallCacheLocation [<String>]] [-PassthroughRecallCacheSizeInGB [<Integer >]] [-EnablePlaceholderRecalls [<SwitchParameter>]] [-MaxRecallThreads [<Integer>]] [-RecallLimitMaxRecalls [<Integer>]] [-RecallLimitTimeInterval [<Integer>]] [-IgnoreRecallLimitForLocalAdministrators [<SwitchParameter>]] [-UsePlaceholderShortcuts [<SwitchParameter>]] [-DataMoverAccountDetails [<PSCredential>]] [-PortNumber [<Integer>]] [-SSLRequired [<SwitchParameter>]] [<CommonParameters>]

Set-EVFSAFileServer [-SiteId <String>] [-FileServer] <-FileServer> [-EnableArchiving [<SwitchParameter>]] [-ActionOnPlaceholderDelete {RetainArchivedFile | DeleteArchivedFile}] [-EnablePassthroughRecall [<SwitchParameter>]] [-PassthroughRecallCacheLocation [<String>]] [-PassthroughRecallCacheSizeInGB [<Integer >]] [-EnablePlaceholderRecalls [<SwitchParameter>]] [-MaxRecallThreads [<Integer>]] [-RecallLimitMaxRecalls [<Integer>]] [-RecallLimitTimeInterval [<Integer>]] [-IgnoreRecallLimitForLocalAdministrators [<SwitchParameter>]] [-UsePlaceholderShortcuts [<SwitchParameter>]] [-DataMoverAccountDetails [<PSCredential>]] [-PortNumber [<Integer>]] [-SSLRequired [<SwitchParameter>]] [<CommonParameters>]

Parameters

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

-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. You can use Get-EVFSAFileServer to obtain the file server name.

Parameter aliases: FileServerDNSName, FileServerName, FileServerId.

-FileServer

Specifies the FileServer object. Note that the cmdlet uses only the FileServerId property from the specified object to identify the file server target. You need to specify the parameters that you want to update.

-EnableArchiving

Enables File System Archiving on the file server. To disable, type -EnableArchiving:$false.

-ActionOnPlaceholderDelete

Specifies whether to retain or delete the archived file when the placeholder is deleted. Possible values are RetainArchivedFile and DeleteArchivedFile.

-EnablePassthroughRecall

Enables pass-through recall on Windows and NetApp 7-mode file servers. For NetApp filers, pass-through recall uses the cache location that is defined in the properties of the Enterprise Vault server. You must configure this cache manually if it is not already present.

-PassthroughRecallCacheLocation

Specifies the pass-through recall cache location for Windows file servers.

-PassthroughRecallCacheSizeInGB

Specifies the pass-through recall cache location size for Windows file servers, in gigabytes.

-EnablePlaceholderRecalls

Enables placeholder recalls on the NetApp file server.

-MaxRecallThreads

Specifies the maximum number of recall threads to be used when you recall items on the NetApp file server. This value is equivalent to the number of simultaneous recalls.

-RecallLimitMaxRecalls

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

-RecallLimitTimeInterval

Specifies the time interval in seconds that is used along with 'RecallLimitMaxRecalls' to control the rate of recalling items on the NetApp file server.

-IgnoreRecallLimitForLocalAdministrators

Controls whether the recall limits apply to members of the local Administrators group for the NetApp file server.

-UsePlaceholderShortcuts

Enables placeholder shortcuts on the Celerra/VNX file server.

-DataMoverAccountDetails

Specifies the user name and password of the account on the Celerra/VNX Data Mover that Enterprise Vault can use for authentication.

-PortNumber

Specifies the Celerra/VNX port number on which the Data Mover services (DHSM) are configured.

-SSLRequired

Specifies whether the Celerra/VNX Data Mover HTTP server uses the Secure Sockets Layer (SSL) when placeholder shortcuts are enabled.

Examples

  • Set-EVFSAFileServer -Identifier \\abc - EnableArchiving

    or

    Set -EVFSAFileServer -FileServerName \\abc - EnableArchiving

    Enables File System Archiving for the file server with the UNC name '\\abc'.

  • Set-EVFSAFileServer -SiteId 198...example.com -Identifier abc.example.com - EnableArchiving:$false

    or

    Set-EVFSAFileServer -SiteId 198...example.com - FileServerDNSName abc.example.com - EnableArchiving:$false

    Disables File System Archiving on the file server with the fully-qualified domain name 'abc.example.com'.

  • Set-EVFSAFileServer -Identifier \\NetAppFS -EnablePlaceholderRecalls -MaxRecallThreads 10 -RecallLimitMaxRecalls 20 -RecallLimitTimeInterval 30 - IgnoreRecallLimitForLocalAdministrators

    Enables placeholder recalls, updates the maximum number of recall threads, and the rate at which an administrator can recall files on a NetApp file server with UNC name '\\NetAppFS'. This command also specifies that recall limits should be ignored for the local Administrators group.

  • Set-EVFSAFileServer -Identifier \\VNXFS -UsePlaceHolderShortcuts -PortNumber 5080 -SSLRequired:$false -DataMoverAccountDetails (Get-Credential)

    Enables placeholder shortcuts and updates the Data Mover account details for a Celerra/VNX file server with the UNC name '\\VNXFS'.

  • Set-EVFSAFileServer \\abc -ActionOnPlaceholderDelete RetainArchivedFile

    Updates the action on placeholder deletion setting to 'Retain archived file' for the file server with the UNC name '\\abc'.

  • Set-EVFSAFileServer \\abc -EnablePassthroughRecall -PassthroughRecallCacheLocation "C:\CacheLocation" -PassthroughRecallCacheSizeInGB 5

    Enables pass-through recall on the Windows file server with the UNC name '\\abc'. This command also updates the pass-through recall cache location and cache size.

  • Set-EVFSAFileServer -FileServer $obj -EnableArchiving

    Enables File System Archiving for the file server that is identified by using the input FileServer object.

    Note:

    To create the FileServer object, run the following command: $obj = Get-EVFSAFileServer -FileServerName \\abc

  • Get-EVFSAFileServer -FileServerName \\abc | Set-EVFSAFileServer -EnableArchiving

    Pipes the FileServer object that is obtained from Get-EVFSAFileServer to Set-EVFSAFileServer and enables the file server for archiving.

  • Set-EVFSAFileServer \\NetAppFS -EnablePassthroughRecall

    Enables pass-through recall on the NetApp 7-mode file server with the UNC name '\\NetAppFS'.

Output

The following tables list the properties that are available:

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

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

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.

Related cmdlets