Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Get-EVFSAComputerSettings
- Get-EVFSAFileServer
- Get-EVFSAFolder
- Get-EVFSASiteSettings
- Get-EVFSAVolume
- New-EVFSAFileServer
- New-EVFSAFolder
- New-EVFSAVolume
- Remove-EVFSAFileServer
- Remove-EVFSAFolder
- Remove-EVFSAVolume
- Set-EVFSAComputerSettings
- Set-EVFSAFileServer
- Set-EVFSAFolder
- Set-EVFSASiteSettings
- Set-EVFSAVolume
- Archiving: Skype for Business
- Archiving: SMTP
- Get-EVSMTPHoldingFolder
- Get-EVSMTPMessageTrackingLogLocation
- Get-EVSMTPPolicy
- Get-EVSMTPServerSettings
- Get-EVSMTPTarget
- New-EVSMTPPolicy
- New-EVSMTPServerSettings
- New-EVSMTPTarget
- Remove-EVSMTPPolicy
- Remove-EVSMTPTarget
- Set-EVSMTPMessageTrackingLogLocation
- Set-EVSMTPPolicy
- Set-EVSMTPServerSettings
- Set-EVSMTPTarget
- Sync-EVSMTPServerSettings
- Backup
- Get-EVIndexSnapshotLocationBackupMode
- Set-EVIndexSnapshotLocationBackupMode
- Clear-EVIndexSnapshotLocationBackupMode
- Get-IndexLocationBackupMode
- Set-IndexLocationBackupMode
- Clear-IndexLocationBackUpMode
- Get-VaultStoreBackupMode
- Set-VaultStoreBackupMode
- Clear-VaultStoreBackupMode
- Set-EVIndexSnapshotLocation
- Get-EVIndexSnapshotLocation
- Remove-EVIndexSnapshotLocation
- New-EVIndexSnapshot
- Get-EVIndexSnapshot
- Remove-EVIndexSnapshot
- Restore-EVIndexSnapshot
- Get-EVIndexSnapshotRepository
- Remove-EVIndexSnapshotRepository
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- Set-EVClassificationVICFIPSMode
- New-EVClassificationPolicy
- Publish-EVClassificationFCIRules
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Set-EVFSAVolume
Set-EVFSAVolume updates the specified settings of an existing file server volume. For Celerra shares, if the volume policy has both pass-through and enabled, then you are prompted to confirm the action because it can lead to data loss.
Set-EVFSAVolume is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.
Set-EVFSAVolume [-SiteId <String>] [-Name] <String> [-FileServerName] <String> [[-TaskName] <String>] [[-PolicyName] <String>] [-DisableArchiving [<SwitchParameter>]] [-PassthroughRecall [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]
Set-EVFSAVolume [-SiteId <String>] [-Name] <String> -FileServerId <String> [-TaskId <String>] [-PolicyId <String>] [-DisableArchiving [<SwitchParameter>]] [-PassthroughRecall [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]
Table: Set-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, Set-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 volume that you want to update. |
-FileServerName (required) | The fully-qualified DNS name or the alias of the file server target configured under the Enterprise Vault site that hosts the volume. |
-FileServerId (required) | The ID of the file server target that hosts the volume share. |
-TaskName | 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 | 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 | The name of the FSA volume policy that you want to use for the new volume. |
-PolicyId | 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. |
-PassthroughRecall | If specified, enables pass-through recall with this volume. This option is configurable only for volume shares that are hosted on a Windows file server. It is available only if you have configured pass-through recall on the file server. |
Set-EVFSAVolume - SiteId 198…example.com -Name Sales -FileServerId 1FB…example.com -PolicyId 10C…example.com -TaskId 120…example.com
Updates the policy and task of the volume 'Sales' on the file server with ID '1FB…example.com', using ID values of policy and task.
Set-EVFSAVolume - SiteId 198…example.com -Name Finance -FileServerName WindowsFiler.example.com -PolicyName 'FSA Volume Policy' -TaskName 'File System Archiving Task'
Updates the policy and task of the volume 'Finance' on the file server with the fully-qualified DNS name 'WindowsFiler.example.com', using name values.
Set-EVFSAVolume - SiteId 198…example.com -Name HumanResources -FileServerName \\WindowsFiler - DisableArchiving -PassthroughRecall
Disables archiving and enables pass-through recall for the volume 'HumanResources' on the file server '\\WindowsFiler'.
Table: Set-EVFSAVolume properties lists the properties that are available.
Table: Set-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. |
See Get-EVSite.
See Get-EVFSAVolume.
See New-EVFSAVolume.
See Remove-EVFSAVolume.