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
Restore-EVIndexSnapshot
Restore-EVIndexSnapshot restores the specified snapshot of index data of the specified Enterprise Vault index server on the Enterprise Vault index server where command is executed.
Restore-EVIndexSnapshot [-EVServerName <String>] -SnapshotName <String> -SnapshotServerName <String> [-IgnoreUnavailable <SwitchParameter>] [-IncludeGlobalState <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]
Restore-EVIndexSnapshot restores the specified snapshot of index data of the specified Enterprise Vault index server on the Enterprise Vault index server where command is executed.
Restore-EVIndexSnapshot is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Table: Restore-EVIndexSnapshot parameters
Parameter | Description |
|---|---|
-SnapshotName | The name of the index snapshot which you want to restore. |
-SnapshotServerName | The name of the Enterprise Vault index server to which the specified index snapshot belongs. |
-IgnoreUnavailable | You can use IgnoreUnavailable switch to determine whether command returns an error for any data stream or index that is missing. If false, the command returns an error for any data stream or index that is missing. If true, the command ignores data streams and indices those are missing. |
-IncludeGlobalState | You can use IncludeGlobalState switch to determine whether command restores the snapshot's cluster state and feature state. If false, the snapshot's cluster state and feature state are not restored. If true, the snapshot's cluster state and feature state are also restored. |
-Confirm | You can use the Confirm switch to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax. |
-WhatIf | The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can preview the changes that would occur without applying any of those changes. You do not need to specify a value with the WhatIf switch. |
C:\PS> Restore-EVIndexSnapshot -SnapshotName 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' -SnapshotServerName 'smtpev2.rail.com'
Restores the index snapshot 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' of the Enterprise Vault index server 'smtpev2.rail.com' on the current Enterprise Vault index server on which this command is executed.
C:\PS> Restore-EVIndexSnapshot -EVServer 'smptev2.rail.com' -SnapshotName 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' -SnapshotServerName 'smtpev2.rail.com'
Restores the index snapshot 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' of the Enterprise Vault index server 'smtpev2.rail.com' on the specified Enterprise Vault index server.
C:\PS> Restore-EVIndexSnapshot -SnapshotName 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' -SnapshotServerName 'smtpev2.rail.com' -IncludeGlobalState
Restores the index snapshot 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' of the Enterprise Vault index server 'smtpev2.rail.com' on the current Enterprise Vault index server on which this command is executed.
As IncludeGlobalState switch is specified, the command also restores the snapshot's cluster state and feature state.
C:\PS> Restore-EVIndexSnapshot -SnapshotName 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' -SnapshotServerName 'smtpev2.rail.com' -IgnoreUnavailable
Restores the index snapshot 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' of the Enterprise Vault index server 'smtpev2.rail.com', on the current Enterprise Vault index server on which this command is executed.
As IgnoreUnavailable switch is specified, the command ignores data streams and indices that are missing.
C:\PS> Restore-EVIndexSnapshot -SnapshotName 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' -SnapshotServerName 'smtpev2.rail.com' -IncludeGlobalState -IgnoreUnavailable
Restores the index snapshot 'db53a04c-eb3d-4e87-b0c1-f7750191a3c4' of the Enterprise Vault index server 'smtpev2.rail.com', on the current Enterprise Vault index server on which this command is executed.
As IncludeGlobalState switch is specified, the command also restores the snapshot's cluster state and feature state.
As IgnoreUnavailable switch is specified, the command ignores data streams and indices that are missing.
C:\PS> Get-EVIndexSnapshot -Latest | Restore-EVIndexSnapshot
Restores the latest index snapshot of the current Enterprise Vault index server on which this command is executed, on the same server.
None.
Restore-EVIndexSnapshot returns no output.
See New-EVIndexSnapshot.
See Get-EVIndexSnapshot.