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
- Export-EVIndexData
- Import-EVIndexData
- 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
Export-EVIndexData
Export-EVIndexData creates a snapshot of the Elasticsearch index data on an Enterprise Vault Index server. This snapshot is then stored in a specified snapshot repository within the configured snapshot location.
Export-EVIndexData [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [-EVServerName <String>] -RepositoryName <String>
Export-EVIndexData [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] -SiteId <String> [-EVServerName <String>] -RepositoryName <String>
Export-EVIndexData creates a new snapshot of the Elasticsearch data of the source Enterprise Vault index server in a snapshot repository specified by the user. The snapshot repository is created if it does not exist in the configured active snapshot location of the source server. This snapshot repository containing all the index data is then copied to the destination Enterprise Vault index server to perform an import. It is recommended to mark all the Elasticsearch index volumes offline before this operation to prevent new data from being added to these index volumes.
Table: Export-EVIndexData parameters
Parameter | Type | Description |
|---|---|---|
-WhatIf | SwitchParameter | Instructs the command to simulate its actions on the object. Using the WhatIf switch, you can preview the impending changes without executing them. You do not need to specify a value when using WhatIf. |
-Confirm | SwitchParameter | Suppresses 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. |
-EVServerName | String | The name of the Enterprise Vault index server for which you want to take the snapshot. If you do not provide this parameter, Export-EVIndexData uses the hostname of the Enterprise Vault index server where the command is executed. To obtain the Enterprise Vault index server name, you can use the Get-EVComputers command. |
-RepositoryName | String | The name of the snapshot repository where you want to create the new index snapshot. This repository will be utilized for importing index data to another server. |
-SiteId | String | The ID of the Enterprise Vault site for which you want to export the Elasticsearch index data on all the Enterprise Vault index servers within that site. If you omit this parameter, Export-EVIndexData retrieves the SiteId from the Enterprise Vault index server specified as EVServerName parameter; otherwise, it uses the SiteId of the Enterprise Vault index server where the command is running. |
Symantec.EnterpriseVault.Admin.EVIndexSnapshot
This command returns the object(s) of the type Symantec.EnterpriseVault.Admin.EVIndexSnapshot, which is composed of the following properties:
Table: Outputs of Export-EVIndexData
Name | Type | Description |
|---|---|---|
SiteId | String | The ID of the Enterprise Vault site in which the index snapshot location is configured. |
SiteNameOrId | String | The name or ID of the Enterprise Vault site in which the index snapshot location is configured. |
SnapshotServerName | String | The name of the Enterprise Vault Index server in which the index snapshot is created. |
RepositoryName | String | Name of the index snapshot repository in which the index snapshot is created. |
RepositoryFullPath | String | The path where the index snapshot is created. |
SnapshotName | String | Name of the index snapshot. |
Version | String | The version of Elasticsearch is being used to create the index snapshot. |
SnapshotState | Enterprise Vault. Admin. Snapshot States | Indicates the state of the index snapshot. |
CreatedDate | Integer | The date on which the index snapshot was taken. |
FailureReason | String | In case of failure in 'SnapshotState', this states the reason for failure. |
Export-EVIndexData -RepositoryName MysnapshotRepository
Takes a snapshot of all the Elasticsearch index data on the local Enterprise Vault server to the snapshot repository MysnapshotRepository. It creates the repository, MysnapshotRepository, if it does not exist.
Export-EVIndexData -RepositoryName MySnapshotRepository -EVServername myserveralias.domain.com
This command takes a snapshot of all the Elasticsearch index data in the Enterprise Vault Index server myserveralias.domain.com in the snapshot repository, MySnapshotRepository, at its registered snapshot location.
Export-EVIndexData -RepositoryName MySnapshotRepository -SiteId 1EAAA1FC6701FFE418634C02A2B6E33D21d10000myEVAlias
This command takes a snapshot of all the Elasticsearch index data in all Enterprise Vault Index servers belonging to the Site ID 1EAAA1FC6701FFE418634C02A2B6E33D21d10000myEVAlias. Each snapshot is taken in the snapshot repositoryMySnapshotRepository in the registered snapshot location of the respective Enterprise Vault index server. The repository is created if it does not exist.
To see examples of Export-EVIndexData, type get-help Export-EVIndexData -examples.
For more information about Export-EVIndexData, type get-help Export-EVIndexData -detailed.
For more technical information about Export-EVIndexData, type get-help Export-EVIndexData -full.
See Import-EVIndexData.