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
New-EVIndexSnapshot
New-EVIndexSnapshot creates the snapshot of index data on the specified Enterprise Vault index server in the specified Enterprise Vault site.
New-EVIndexSnapshot [-EVServerName <String>] [-IgnoreUnavailable [<SwitchParameter>]] [-IncludeGlobalState [<SwitchParameter>]] [<CommonParameters>]
New-EVIndexSnapshot -SiteId <String> [-EVServerName <String>] [-IgnoreUnavailable [<SwitchParameter>]] [-IncludeGlobalState [<SwitchParameter>]] [<CommonParameters>]
New-EVIndexSnapshot creates the incremental snapshot of index data on the specified Enterprise Vault index server in the specified Enterprise Vault site.
It also creates the incremental snapshot of index data on the Enterprise Vault index servers in the specified Enterprise Vault site. The snapshots are incremental and can be taken on live index data during indexing is in progress.
New-EVIndexSnapshot is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.
Table: New-EVIndexSnapshot parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the Enterprise Vault site for which you want to create the snapshots of index data on all the Enterprise Vault index servers in that site. If you omit this parameter, New-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 create the snapshot of index data. If you omit this parameter, New-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. |
-IgnoreUnavailable | (Optional, Boolean) If false, the command returns an error for any data stream or index that is missing or closed. Defaults to false. If true, the command ignores data streams and indices those are missing or closed. |
-IncludeGlobalState | (Optional, Boolean) If true, the current global state of Elasticasearch cluster running on Enterprise Vault index server is included in the snapshot. Defaults to false. |
-Confirm | You can use the Confirm switch to suppress 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. |
C:\PS> New-EVIndexSnapshot
Creates index snapshot of the current Enterprise Vault index server on which this command is executed.
C:\PS> New-EVIndexSnapshot -SiteId site.domain.com
Creates index snapshot of all Enterprise Vault index servers under site 'site.domain.com'.
C:\PS> New-EVIndexSnapshot -EVServerName ev.domain.local
Create index snapshot of the Enterprise Vault index server 'ev.domain.local'.
C:\PS> New-EVIndexSnapshot -EVServerName ev.domain.local -IgnoreUnavailable
Create index snapshot of the Enterprise Vault index server 'ev.domain.local', if is set to false, the command returns an error for any data stream or index that is missing or closed. If true, the command ignores data streams and indices in indices that are missing or closed.
C:\PS> New-EVIndexSnapshot -EVServerName ev.domain.local -IncludeGlobalState
Create index snapshot of the Enterprise Vault index server 'ev.domain.local'. If is true, the current global state of Elasticasearch cluster running on Enterprise Vault index server is included in the snapshot.
C:\PS> New-EVIndexSnapshot -EVServerName ev.domain.local -IgnoreUnavailable -IncludeGlobalState
Create index snapshot of the Enterprise Vault index server 'ev.domain.local', if is set to false, the command returns an error for any data stream or index that is missing or closed. If true, the command ignores data streams and indices in indices that are missing or closed. If is true, the current global state of Elasticasearch cluster running on Enterprise Vault index server is included in the snapshot.
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 | Date | The date on which index snapshot was taken. |
FailureReason | String | In case of failure in 'SnapshotState', this states the reason of failure. |