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-EVElasticsearchIndex
Get-EVElasticsearchIndex retrieves details of all the Elasticsearch indices of the specified archive from the Elasticsearch.
Get-EVElasticsearchIndex is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Get-EVElasticsearchIndex -ArchiveId <String> [-IndexState <String>] [<CommonParameters>]
Table: Get-EVElasticsearchIndex parameters
Parameter | Description |
|---|---|
-ArchiveId (required) | The ID for the archive for which you want to retrieve the details of the indices. |
-IndexState | The state (Open/Close) of the index with which you want to filter the results. |
C:\PS> Get-EVElasticsearchIndex -ArchiveId "116C02E87F248354DA9E9FECEDA650C721110000VJ-SQL.QA.COM"
List all the Elasticsearch indices of the archive "116C02E87F248354DA9E9FECEDA650C721110000VJ-SQL.QA.COM".
C:\PS> Get-EVArchive | Get-EVElasticsearchIndex
List all the Elasticsearch indices of the archive(s) returned by the Get-EVArchive command.
C:\PS> Get-EVElasticsearchIndex -ArchiveId "116C02E87F248354DA9E9FECEDA650C721110000VJ-SQL.QA.COM" -IndexState "Open"
List all the open Elasticsearch indices of the archive of which archive ID is specified.
C:\PS> Get-EVArchive | Get-EVElasticsearchIndex -IndexState "Close"
List all the Elasticsearch closed indices of the archive(s) returned by the Get-EVArchive command.
This command returns the object(s) of type Symantec.EnterpriseVault.PowerShell.AdminAPI.ElasticsearchIndex composed of the following properties:
Table: Get-EVElasticsearchIndex properties
Name | Type | Description |
|---|---|---|
ArchiveId | String | The ID for the archive of the Elasticsearch index. |
IndexName | String | The name of the Elasticsearch index which is associated with the archive ID. |
IndexState | String | The state of the Elasticsearch index. |
IndexStatus | ElasticsearchIndexStatus enumeration value | The health status of the index. |
IndexedItems | Integer | Number of items in the index. |
IndexSizeInMB | Integer | Size of the index in MBs. |
ShardsCount | Integer | Number of shards in the index. |
EVServerEntryId | String | EntryId of Enterprise Vault index server of Elasticsearch index. |