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-EVIndexSnapshotLocationBackupMode
Get-EVIndexSnapshotLocationBackupMode retrieves the current backup mode settings of the specified index snapshot location or all index snapshot locations that are configured on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Get-EVIndexSnapshotLocationBackupMode [-EVServerName <String>] [-Path <String>] [-OnlyInBackup <SwitchParameter>] [<CommonParameters>]
Get-EVIndexSnapshotLocationBackupMode -SiteId <String> [-EVServerName <String>] [-Path <String>] [-OnlyInBackup <SwitchParameter>] [<CommonParameters>]
Get-EVIndexSnapshotLocationBackupMode retrieves the current backup mode settings of the specified index snapshot location or all index snapshot locations that are configured on the specified Enterprise Vault index server in the specified Enterprise Vault site.
Get-EVIndexSnapshotLocationBackupMode is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Table: Get-EVIndexSnapshotLocationBackupMode parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the Enterprise Vault site for which you want to retrieve the current backup mode settings of the index snapshot locations configured on the Enterprise Vault index servers in the specified Enterprise Vault site. If you omit this parameter, Get-EVIndexSnapshotLocationBackupMode 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 current backup mode settings of the index snapshot locations. If you omit this parameter, Get-EVIndexSnapshotLocationBackupMode 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. |
-Path | Path of the index snapshot location for which you want to retrieve the current backup mode settings. |
-OnlyInBackup | Filters the list to show only those index snapshot locations that are in the backup mode. |
C:\PS> Get-EVIndexSnapshotLocationBackupMode
Retrieves the current backup mode settings of all index snapshot locations configured on the Enterprise Vault index server on which this command is executed.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -EVServerName evserver.earth.local
Retrieves the current backup mode settings of all index snapshot locations configured on the Enterprise Vault index server 'evserver.earth.local'.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -Path e:\indexsnapshotlocation
Retrieves the current backup mode settings of the index snapshot location 'e:\indexsnapshotlocation' configured on the Enterprise Vault index server on which this command is executed.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -EVServerName evserver.earth.local -Path e:\indexsnapshotlocation
Retrieves the current backup mode settings of the index snapshot location 'e:\indexsnapshotlocation' configured on the Enterprise Vault index server 'evserver.earth.local'.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -SiteId 17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local
Retrieves the current backup mode settings of all index snapshot locations configured on all Enterprise Vault index servers in the Enterprise Vault site '17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local'.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -SiteId 17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local -EVServerName evserver.earth.local
Retrieves the current backup mode settings of all index snapshot locations configured on the Enterprise Vault index server 'evserver.earth.local' in the Enterprise Vault site '17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local'.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -SiteId 17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local -EVServerName evserver.earth.local -Path e:\indexsnapshotlocation
Retrieves the current backup mode settings of the index snapshot location 'e:\indexsnapshotlocation' configured on the Enterprise vault index server 'evserver.earth.local' in the Enterprise Vault site '17EEC4C7A9E1E4540AE93FC7B20C6A7311d10000evserver.earth.local'.
C:\PS> Get-EVSite | Get-EVIndexSnapshotLocationBackupMode
Retrieves the current backup mode settings of all index snapshot locations configured on all Enterprise Vault index servers in the Enterprise Vault site returned by the Get-EVSite command.
C:\PS> Get-EVComputers | Get-EVIndexSnapshotLocationBackupMode
Retrieves the current backup mode settings of all index snapshot locations configured on all Enterprise Vault index servers returned by the Get-EVComputers command.
C:\PS> Get-EVIndexSnapshotLocation | Get-EVIndexSnapshotLocationBackupMode
Retrieves the current backup mode settings of all index snapshot locations returned by the Get-EVIndexSnapshotLocation command.
C:\PS> Get-EVIndexSnapshotLocation -OnlyActive | Get-EVIndexSnapshotLocationBackupMode
Retrieves the current backup mode settings of the active index snapshot location returned by the Get-EVIndexSnapshotLocation command.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -OnlyInBackup
Retrieves the current backup mode settings of all index snapshot locations that are in the backup mode.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -OnlyInBackup:$true
Retrieves the current backup mode settings of all index snapshot locations that are in the backup mode.
C:\PS> Get-EVIndexSnapshotLocationBackupMode -OnlyInBackup:$false
Retrieves the current backup mode settings of all index snapshot locations that are not in the backup mode.
Symantec.EnterpriseVault.Admin.IndexSnapshotLocationBackup
This command returns the object(s) of type Symantec.EnterpriseVault.Admin.IndexSnapshotLocationBackup which is composed of the following properties:
Table: Get-EVIndexSnapshotLocationBackupMode 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. |
BackupModeRefCount | Integer | Indicates the backup mode reference count of the index snapshot location. |