Veritas Enterprise Vault™ PowerShell Cmdlets
Clear-VaultStoreBackupMode
Clear-VaultStoreBackupMode decrements the backup mode count on one vault store, on all the vault stores in a vault store group, or on all the vault stores in a site.
Enterprise Vault maintains a count of backup mode requests for each vault store. For example, if you use concurrent backup scripts in your environment, the backup mode count can be higher than 1. Backup mode is not cleared until the backup mode count reduces to 0.
Clear-VaultStoreBackupMode is provided by Symantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by the Enterprise Vault Management Shell.
Clear-VaultStoreBackupMode [-Name] <String> [-EVServerName] <String> [-EvObjectType] <EVObjectType> [-ForceClearBackupMode <Boolean>] [-SuppressConfirm] [<CommonParameters>]
Clear-VaultStoreBackupMode -EntryId <String> [-ForceClearBackupMode <Boolean>] [-SuppressConfirm] [<CommonParameters>]
Table: Clear-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 Clear-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. |
-ForceClearBackupMode | Use -ForceClearBackupMode:$true to forcibly clear backup mode. Clear-VaultStoreBackupMode then ignores the existing backup mode count and sets it to 0. |
-SuppressConfirm | Use -SuppressConfirm to suppress the prompt for confirmation when you use -ForceClearBackupMode:$true. This parameter is only available when you use -ForceClearBackupMode:$true. |
Clear-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore
Decrements the backup mode count on vault store VS1.
Clear-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore -ForceClearBackupMode:$true
Forcibly clears backup mode from vault store VS1. Clear-VaultStoreBackupMode ignores the existing backup mode count and sets it to 0. In this example, Windows PowerShell prompts for confirmation before it executes the cmdlet.
Clear-VaultStoreBackupMode VS1 EVServer-Win2k3 VaultStore -ForceClearBackupMode:$true -SuppressConfirm
Forcibly clears backup mode from vault store VS1. Clear-VaultStoreBackupMode ignores the existing backup mode count and sets it to 0. In this example, Windows PowerShell does not prompt for confirmation before it executes the cmdlet.
Clear-VaultStoreBackupMode VSG1 EVServer-Win2k3 VaultStoreGroup
Decrements the backup mode count on all the vault stores in vault store group VSG1.
Clear-VaultStoreBackupMode Site1 EVServer-Win2k3 Site
Decrements the backup mode count on all the vault stores in Site1.
Clear-VaultStoreBackupMode -EntryId 1F3...Domain.local
Decrements the backup mode count on 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 backup mode count is decremented on that vault store.
If you specify the ID of a vault store group or a site, the backup mode count is decremented on the vault stores that belong to the group or site.
There is a confirmation message on completion.