Convert-MBSBackupPlanToNBF
Converts the backup plan from legacy backup format to the new backup format (NBF).
Convert-MBSBackupPlanToNBF
[[-ID] <String>]
[[-Name] <String>]
[[-MasterPassword] <SecureString>]
[[-PurgeLegacy] <Boolean>]
[-Whatif]
[-Force]
[-PassThru]
[<CommonParameters>]
Description
Converts the backup plan from legacy backup format to the new backup format (NBF). The minimum supported version of the MBS backup agent is 7.8.3.
Examples
Example 1: Convert all legacy file backup plans to the new backup format (NBF).
PS C:\> Get-MBSBackupPlan -StorageType All -PlanFormat CBF -PlanType File-Level | Convert-MBSBackupPlanToNBF -PurgeLegacy
Example 2: Test conversion to the new backup format of a backup plan named "test". If the command outputs warnings, the convertion should be performed with the -Force switch to ignore them.
PS C:\> Convert-MBSBackupPlanToNBF -Name test -Whatif
Parameters
-ID
Specifies Plan ID.
| Type | String |
| Required: | false |
| Position: | 1 |
| Default value: | |
| Accept pipeline input: | true (ByPropertyName) |
| Accept wildcard characters: | false |
-Name
Specifies Plan Name.
| Type | String |
| Required: | false |
| Position: | 2 |
| Default value: | |
| Accept pipeline input: | true (ByPropertyName) |
| Accept wildcard characters: | false |
-MasterPassword
Master password. Should be specified if configuration is protected by master password. Use -MasterPassword (ConvertTo-SecureString -string "Your_Password" -AsPlainText -Force)
| Type | SecureString |
| Required: | false |
| Position: | 3 |
| Default value: | |
| Accept pipeline input: | false |
| Accept wildcard characters: | false |
-PurgeLegacy
Allows to enable/disable purging of legacy data for converted plan. Possible values: $true/$false
| Type | Boolean |
| Required: | false |
| Position: | 4 |
| Default value: | True |
| Accept pipeline input: | false |
| Accept wildcard characters: | false |
-Whatif
| Type | SwitchParameter |
| Required: | false |
| Position: | named |
| Default value: | False |
| Accept pipeline input: | false |
| Accept wildcard characters: | false |
-Force
Converts forcefully, warnings are ignored.
| Type | SwitchParameter |
| Required: | false |
| Position: | named |
| Default value: | False |
| Accept pipeline input: | false |
| Accept wildcard characters: | false |
-PassThru
| Type | SwitchParameter |
| Required: | false |
| Position: | named |
| Default value: | False |
| Accept pipeline input: | false |
| Accept wildcard characters: | false |
CommonParameters
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.