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
Get-EVIndexSnapshot
Get-EVIndexSnapshot retrieves details of index snapshot of the specified Enterprise Vault index server in the specified Enterprise Vault site.
Get-EVIndexSnapshot [-EVServerName <String>] [-SnapshotName <String>] [-RepositoryName <String>] [-State {Failed | Success | InProgress | Partial}] [-Latest <SwitchParameter>] [<CommonParameters>]
Get-EVIndexSnapshot -SiteId <String> [-EVServerName <String>] [-SnapshotName <String>] [-RepositoryName <String>] [-State {Failed | Success | InProgress | Partial}] [-Latest <SwitchParameter>] [<CommonParameters>]
Get-EVIndexSnapshot retrieves details of specified or all index snapshot(s) of the specified Enterprise Vault index server in the specified Enterprise Vault site.
It also retrieves details of all the index snapshots of all the Enterprise Vault index servers in the specified Enterprise Vault site.
Get-EVIndexSnapshot is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Table: Get-EVIndexSnapshot parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the Enterprise Vault site for which you want to retrieve the index snapshots. If you omit this parameter, Get-EVIndexSnapshot 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. You can use the Get-EVSite command to obtain the SiteId. |
-EVServerName | The name of the Enterprise Vault index server for which you want to retrieve the index snapshots. If you omit this parameter, Get-EVIndexSnapshot uses the host name of the Enterprise Vault index server where the command is running. You can use the Get-EVComputers command to obtain the Enterprise Vault server name. |
-SnapshotName | The name of the index snapshot for which you want to retrieve details. |
-RepositoryName | The name of the index snapshot repository from which you want to retrieve details of the index snapshots. |
-State | Filters list of returned index snapshots based on its state. |
-Latest | This filter shows only latest index snapshot. |
C:\PS> Get-EVIndexSnapshot
List all the index snapshots of the current Enterprise Vault index server on which this command is executed.
C:\PS> Get-EVIndexSnapshot -ServerName win12r2.domain.local
List all the index snapshots of the Enterprise Vault index server 'win12r2.domain.local'.
C:\PS> Get-EVIndexSnapshot -EVServerName win12r2.domain.local
List all the index snapshots of the Enterprise Vault index server 'win12r2.domain.local'.
C:\PS> Get-EVIndexSnapshot -SnapshotName 'fd10805e-1a95-4ddd-bbc1-45a3a346e48d'
Retrieve details of index snapshots with name 'fd10805e-1a95-4ddd-bbc1-45a3a346e48d' for the current Enterprise Vault index server on which command is executed.
C:\PS> Get-EVIndexSnapshot -RepositoryName '8ghcfcef-2502-4ff4-a066-f3fb165c7f09'
List all the index snapshots created in the index snapshot repository '8ghcfcef-2502-4ff4-a066-f3fb165c7f09' for the current Enterprise Vault index server.
C:\PS> Get-EVIndexSnapshot -State InProgress
List all the index snapshots that are in progress for the current Enterprise Vault index server.
C:\PS> Get-EVIndexSnapshot -RepositoryName '1afcfcef-2502-4ff4-a066-f3fb165c7f08' -State:0
List all the index snapshots inside repository '1afcfcef-2502-4ff4-a066-f3fb165c7f08' for the current Enterprise Vault index server that are successful.
C:\PS> Get-EVIndexSnapshotRepository | Get-EVIndexSnapshot
Lists all index snapshots created in all index snapshot repositories returned by the command Get-EVIndexSnapshotRepository.
C:\PS> Get-EVIndexSnapshotLocation -OnlyActive| Get-EVIndexSnapshotRepository -OnlyInUse | Get-EVIndexSnapshot
Lists all index snapshots created in index snapshot repository which in-use in the active index snapshot location for the current Enterprise Vault index server.
C:\PS> Get-EVIndexSnapshot -SiteId 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local
Lists all index snapshots of all Enterprise Vault index servers in the Enterprise Vault site '1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local'.
C:\PS> Get-EVIndexSnapshot -SiteId 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local -EVServerName win12r2.domain.local
Lists all index snapshots of Enterprise Vault index server 'win12r2.domain.local' in the Enterprise Vault site '1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local' -EVServerName.
C:\PS> Get-EVSite | Get-EVIndexSnapshot
Lists all index snapshots of all Enterprise Vault index servers in the Enterprise Vault site returned by the Get-EVSite command.
C:\PS> Get-EVComputers | Get-EVIndexSnapshot
Lists all index snapshots of all Enterprise Vault index servers returned by the Get-EVComputers command.
C:\PS> Get-EVIndexSnapshot -Latest:$true
Retrieve details of latest index snapshot for the current Enterprise Vault index server on which command is executed.
C:\PS> Get-EVSite | Get-EVIndexSnapshot -Latest:$true
Retrieve details of latest index snapshots for all Enterprise Vault index servers in the Enterprise Vault site returned by command Get-EVSite.
Symantec.EnterpriseVault.Admin.IndexSnapshot
This command returns the object(s) of type Symantec.EnterpriseVault.Admin.IndexSnapshot composed of the following properties:
Name | Type | Description |
|---|---|---|
SiteId | String | The ID of the Enterprise Vault site in which the index snapshot is created. |
SiteNameOrId | String | The name or ID of the Enterprise Vault site in which the index snapshot is created. |
SnapshotServerName | String | The name of 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. |
SnapshotIdentity | Integer | An identifier to identify the individual index snapshot. |
SnapshotName | String | Name of the index snapshot. |
Version | String | The version of Elasticsearch being used to create the index snapshot. |
SnapshotState | EnterpriseVault.Admin.SnapshotStates | Indicates the state of the index snapshot. |
CreatedDate | Integer | The date on which index snapshot was taken. |
FailureReason | String | In case of failure in 'SnapshotState', this states the reason of failure. |