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
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- 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-VaultStoreBackupMode
Get-VaultStoreBackupMode reports the current backup mode settings of one vault store, of all the vault stores in a vault store group, or of all the vault stores in a site.
Get-VaultStoreBackupMode is provided by the snap-in Symantec.EnterpriseVault.PowerShell.Snapin.dll.
Get-VaultStoreBackupMode [-Name] <String> [-EVServerName] <String> [-EvObjectType] <EVObjectType> [<CommonParameters>]
Get-VaultStoreBackupMode -EntryId <String> [<CommonParameters>]
Table: Get-VaultStoreBackupMode parameters
Parameter | Description |
|---|---|
-Name (required) | The name of the vault store, vault store group, or site. |
-EVServerName (required) | The Enterprise Vault server that owns the vault store, vault store group, or site. You must provide this parameter if you specify a vault store, vault store group, or site by name rather than ID. This allows Get-VaultStoreBackupMode to find the ID of the vault store, vault store group, or site. |
-EvObjectType (required) | The type of object passed by the Name parameter. Acceptable values are VaultStore, VaultStoreGroup and Site. You must provide this parameter if you specify a vault store, vault store group, or site by name rather than ID. |
-EntryId (required) | The ID of the vault store, vault store group, or site. |
Get-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore
Reports the current backup mode setting of vault store VS1.
Get-VaultStoreBackupMode VSG1 EVServer-Win2k3 VaultStoreGroup
Reports the current backup mode settings of all the vault stores in vault store group VSG1.
Get-VaultStoreBackupMode Site1 EVServer-Win2k3 Site
Reports the current backup mode settings of all the vault stores in Site1.
Get-VaultStoreBackupMode -EntryId 1F3...Domain.local
Reports the current backup mode settings of the object that has the specified ID. The ID can be that of a vault store, a vault store group, or a site.
If you specify the ID of a vault store, the current backup mode setting of that vault store is reported.
If you specify the ID of a vault store group or a site, the current backup mode settings of the vault stores that belong to the group or site are reported.
Get-VaultStoreBackupMode -EVServerName EVServer-Win2k3 -EVObjectType VaultStore -Name VS1
Reports the current backup mode setting on vault store VS1.
In this example, the parameters must be named because they are not in the default order.
Table: Get-VaultStoreBackupMode properties lists the properties that are available.
Table: Get-VaultStoreBackupMode properties
Name | Type | Description |
|---|---|---|
BackupMode | Boolean | Indicates whether the vault store is in backup mode. Possible values: $true (the vault store is in backup mode), $false (the vault store is not in backup mode). |
VaultStoreEntryId | String | The VaultStoreEntryId. |
VaultStoreName | String | The name of the vault store. |