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-EVIndexSnapshotLocation
Get-EVIndexSnapshotLocation retrieves details of all the index snapshot locations that are configured on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Get-EVIndexSnapshotLocation [-EVServerName <String>] [-OnlyActive <SwitchParameter>] [<CommonParameters>]
Get-EVIndexSnapshotLocation -SiteId <String> [-EVServerName <String>] [-OnlyActive <SwitchParameter>] [<CommonParameters>]
Get-EVIndexSnapshotLocation retrieves details of all the index snapshot locations that are configured on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Get-EVIndexSnapshotLocation is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Table: Get-EVIndexSnapshotLocation parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the Enterprise Vault site for which you want to retrieve the index snapshot locations. If you omit this parameter, Get-EVIndexSnapshotLocation retrieves SiteId from Enterprise Vault index server specified as EVServerName parameter; otherwise, it uses the ID of the site 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 snapshot locations. If you omit this parameter, Get-EVIndexSnapshotLocation 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 index server name. |
-OnlyActive | Filters the list to show only active index snapshot locations. |
C:\PS> Get-EVIndexSnapshotLocation
List all the index snapshot locations of the Enterprise Vault index server on which this command is executed.
C:\PS> Get-EVIndexSnapshotLocation -ServerName win12r2.domain.local
List all the index snapshot locations of the Enterprise vault index server 'win12r2.domain.local'.
C:\PS> Get-EVIndexSnapshotLocation -OnlyActive
List all the active index snapshot locations for the current Enterprise vault index server.
C:\PS> Get-EVIndexSnapshotLocation -OnlyActive:$false
List all the non-active index snapshot locations for the current Enterprise vault index server.
C:\PS> Get-EVIndexSnapshotLocation -OnlyActive:$true
List all the active index snapshot locations for the current Enterprise vault index server.
C:\PS> Get-EVIndexSnapshotLocation -ServerName win12r2.domain.local -OnlyActive
List all the active index snapshot locations of the Enterprise Vault index server 'win12r2.domain.local'.
C:\PS> Get-EVIndexSnapshotLocation -SiteId 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local
List all the index snapshot locations of all the Enterprise Vault index servers in the specified Enterprise Vault site.
C:\PS> Get-EVIndexSnapshotLocation -SiteId 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local -ServerName win12r2.domain.local
List all the index snapshot locations in the specified Enterprise Vault index server in specified Enterprise Vault site.
C:\PS> Get-EVSite | Get-EVIndexSnapshotLocation
List all the index snapshot locations of all the Enterprise Vault index servers in the Enterprise Vault site returned by Get-EVSite command.
C:\PS> Get-EVComputers | Get-EVIndexSnapshotLocation
List all the index snapshot locations of all the Enterprise Vault index servers returned by Get-EVComputers command.
Symantec.EnterpriseVault.Admin.IndexSnapshotLocation
This command returns the object(s) of type Symantec.EnterpriseVault.Admin.IndexSnapshotLocation which is composed of the following properties:
Table: Get-EVIndexSnapshotLocation properties
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. |
EVServerEntryId | String | The ID of the Enterprise Vault index server in which the index snapshot location is configured. |
EVServerName | String | The name of Enterprise Vault index server in which the index snapshot location is configured. |
Path | String | The path where the index snapshot location is present. |
BackupMode | Boolean | Indicates whether the index snapshot location is in the backup mode or not. |
Active | Boolean | Indicates whether the index snapshot location is active or not. |
LocationIdentity | Integer | The identity number of the index snapshot location. |