Edit-MBSBackupPlan

NAME Edit-MBSBackupPlan



SYNOPSIS

Edit MBS backup plan.





SYNTAX

Edit-MBSBackupPlan -CommonParameterSet [-ID <String>] [-Name <String>] [-StorageAccountID <String>] [-NewName

<String>] [-DisableEncryption] [-DisableSchedule] [-SyncBeforeRun <Nullable`1>] [-ServerSideEncryption

<Nullable`1>] [-EncryptionAlgorithm <String>] [-EncryptionPassword <SecureString>] [-Compression <Nullable`1>]

[-StorageClass <String>] [-SaveBPConfiguration <Nullable`1>] [-output <String>] [-MasterPassword <SecureString>]

[-RecurringType <String>] [-At <String>] [-DayOfMonth <Int32>] [-WeekDay <String[]>] [-WeekNumber <String>]

[-DailyFrom <String>] [-DailyTill <String>] [-Occurs <String>] [-OccursValue <String>] [-RepeatEvery <Int32>]

[-repeatStartDate <String>] [-stopAfter <String>] [-preActionCommand <String>] [-preActionContinueAnyway

<Nullable`1>] [-postActionCommand <String>] [-postActionRunAnyway <Nullable`1>] [-notification <String>] [-winLog

<String>] [-purge <String>] [-keep <String>] [-keepLastVersion <Nullable`1>] [-delayPurge <String>] [-runMissed

<Nullable`1>] [-RecurringTypeForceFull <String>] [-atForceFull <String>] [-dayForceFull <Int32>]

[-weekdayForceFull <String>] [-weeknumberForceFull <String>] [-dailyFromForceFull <String>] [-dailyTillForceFull

<String>] [-occursForceFull <String>] [-occurValueForceFull <String>] [-repeatEveryForceFull <Int32>]

[-repeatStartDateForceFull <String>] [-stopAfterForceFull <String>] [-rebackupDate <String>]

[-DisableForceFullSchedule] [-useBlockLevelBackup <Nullable`1>] [<CommonParameters>]



Edit-MBSBackupPlan -FileLevelParameterSet [-ID <String>] [-Name <String>] [-SpecialFunction <String>]

[-StorageAccountID <String>] [-NewName <String>] [-DisableEncryption] [-DisableSchedule] [-SyncBeforeRun

<Nullable`1>] [-ServerSideEncryption <Nullable`1>] [-EncryptionAlgorithm <String>] [-EncryptionPassword

<SecureString>] [-Compression <Nullable`1>] [-StorageClass <String>] [-SaveBPConfiguration <Nullable`1>] [-output

<String>] [-MasterPassword <SecureString>] [-RecurringType <String>] [-At <String>] [-DayOfMonth <Int32>]

[-WeekDay <String[]>] [-WeekNumber <String>] [-DailyFrom <String>] [-DailyTill <String>] [-Occurs <String>]

[-OccursValue <String>] [-RepeatEvery <Int32>] [-repeatStartDate <String>] [-stopAfter <String>]

[-preActionCommand <String>] [-preActionContinueAnyway <Nullable`1>] [-postActionCommand <String>]

[-postActionRunAnyway <Nullable`1>] [-notification <String>] [-winLog <String>] [-purge <String>] [-keep <String>]

[-keepLastVersion <Nullable`1>] [-delayPurge <String>] [-runMissed <Nullable`1>] [-RecurringTypeForceFull

<String>] [-atForceFull <String>] [-dayForceFull <Int32>] [-weekdayForceFull <String>] [-weeknumberForceFull

<String>] [-dailyFromForceFull <String>] [-dailyTillForceFull <String>] [-occursForceFull <String>]

[-occurValueForceFull <String>] [-repeatEveryForceFull <Int32>] [-repeatStartDateForceFull <String>]

[-stopAfterForceFull <String>] [-rebackupDate <String>] [-DisableForceFullSchedule] [-useBlockLevelBackup

<Nullable`1>] [-ntfs <Nullable`1>] [-ForceUsingVSS <Nullable`1>] [-sharerw <Nullable`1>]

[-DeleteLocallyDeletedFilesAfter <String>] [-BackupEmptyFolders <Nullable`1>] [-oa <String>] [-es <Nullable`1>]

[-SkipFolders <String>] [-IncludeFilesMask <String>] [-ExcludeFilesMask <String>] [-IgnoreErrorPathNotFound

<Nullable`1>] [-TrackDeletedFiles <Nullable`1>] [-AddNewFile <String>] [-AddNewFolder <String>] [-ExcludeFile

<String>] [-ExcludeDirectory <String>] [-BackupFile <String>] [-BackupDirectory <String>] [-GenerateDetailedReport

<Nullable`1>] [<CommonParameters>]



Edit-MBSBackupPlan -ImageBasedParameterSet [-ID <String>] [-Name <String>] [-SpecialFunction <String>]

[-StorageAccountID <String>] [-NewName <String>] [-DisableEncryption] [-DisableSchedule] [-SyncBeforeRun

<Nullable`1>] [-ServerSideEncryption <Nullable`1>] [-EncryptionAlgorithm <String>] [-EncryptionPassword

<SecureString>] [-Compression <Nullable`1>] [-StorageClass <String>] [-SaveBPConfiguration <Nullable`1>] [-output

<String>] [-MasterPassword <SecureString>] [-RecurringType <String>] [-At <String>] [-DayOfMonth <Int32>]

[-WeekDay <String[]>] [-WeekNumber <String>] [-DailyFrom <String>] [-DailyTill <String>] [-Occurs <String>]

[-OccursValue <String>] [-RepeatEvery <Int32>] [-repeatStartDate <String>] [-stopAfter <String>]

[-preActionCommand <String>] [-preActionContinueAnyway <Nullable`1>] [-postActionCommand <String>]

[-postActionRunAnyway <Nullable`1>] [-notification <String>] [-winLog <String>] [-purge <String>] [-keep <String>]

[-keepLastVersion <Nullable`1>] [-delayPurge <String>] [-runMissed <Nullable`1>] [-RecurringTypeForceFull

<String>] [-atForceFull <String>] [-dayForceFull <Int32>] [-weekdayForceFull <String>] [-weeknumberForceFull

<String>] [-dailyFromForceFull <String>] [-dailyTillForceFull <String>] [-occursForceFull <String>]

[-occurValueForceFull <String>] [-repeatEveryForceFull <Int32>] [-repeatStartDateForceFull <String>]

[-stopAfterForceFull <String>] [-rebackupDate <String>] [-DisableForceFullSchedule] [-useBlockLevelBackup

<Nullable`1>] [-BackupVolumes <String>] [-Volumes <String[]>] [-disableVSS <Nullable`1>] [-ignoreBadSectors

<Nullable`1>] [-useSystemVSS <Nullable`1>] [-prefetchBlockCount <Int32>] [-blockSize <String>] [<CommonParameters>]





DESCRIPTION

Edit MBS supported backup plan. File-Level and Image-Based backup plan type are supported.





PARAMETERS

-FileLevelParameterSet [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ImageBasedParameterSet [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-CommonParameterSet [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ID <String>



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Name <String>



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-SpecialFunction <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-StorageAccountID <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NewName <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DisableEncryption [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-DisableSchedule [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-SyncBeforeRun <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ServerSideEncryption <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EncryptionAlgorithm <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EncryptionPassword <SecureString>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Compression <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-StorageClass <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SaveBPConfiguration <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-output <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MasterPassword <SecureString>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RecurringType <String>

------------------------- Schedule -----------------------------



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-At <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DayOfMonth <Int32>



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-WeekDay <String[]>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WeekNumber <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DailyFrom <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DailyTill <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Occurs <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OccursValue <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RepeatEvery <Int32>



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-repeatStartDate <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-stopAfter <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-preActionCommand <String>

------------------ Pre / Post actions ----------------------------



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-preActionContinueAnyway <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-postActionCommand <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-postActionRunAnyway <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-notification <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-winLog <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-purge <String>

---------------------------- Retention Policy -------------------------



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-keep <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-keepLastVersion <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-delayPurge <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-runMissed <Nullable`1>

-------------------------Full schedule -----------------------------------



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RecurringTypeForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-atForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-dayForceFull <Int32>



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-weekdayForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-weeknumberForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-dailyFromForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-dailyTillForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-occursForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-occurValueForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-repeatEveryForceFull <Int32>



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-repeatStartDateForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-stopAfterForceFull <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-rebackupDate <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DisableForceFullSchedule [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-useBlockLevelBackup <Nullable`1>

---------------------------- Block Level ------------------



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ntfs <Nullable`1>

--------------------------- File Backup settings ------------



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ForceUsingVSS <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-sharerw <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DeleteLocallyDeletedFilesAfter <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-BackupEmptyFolders <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-oa <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-es <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SkipFolders <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IncludeFilesMask <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExcludeFilesMask <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IgnoreErrorPathNotFound <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TrackDeletedFiles <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AddNewFile <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AddNewFolder <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExcludeFile <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExcludeDirectory <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-BackupFile <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-BackupDirectory <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-GenerateDetailedReport <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-BackupVolumes <String>

------------------------- Image-Based --------------------------------------



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Volumes <String[]>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-disableVSS <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ignoreBadSectors <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-useSystemVSS <Nullable`1>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-prefetchBlockCount <Int32>



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-blockSize <String>



Required? false

Position? named

Default value

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String[]

System.String





OUTPUTS

System.Management.Automation.PSCustomObject





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-MBSBackupPlan | Edit-MBSBackupPlan -CommonParameterSet -Compression $true



Enable compression option for all supported backup plans.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-MBSBackupPlan -PlanType File-Level | Edit-MBSBackupPlan -FileLevelParameterSet -ntfs $true



Enable backup NTFS permissions option for all file-level backup plans.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-MBSBackupPlan -PlanType Image-Based | Edit-MBSBackupPlan -ImageBasedParameterSet -BackupVolumes

SystemRequired



Add only system required volumes to all image-based backup plans.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-MBSBackupPlan -StorageType Cloud -PlanType Image-Based | Edit-MBSBackupPlan -ImageBasedParameterSet

-BackupVolumes SystemRequired



Add only system required volumes to cloud image-based backup plans.











RELATED LINKS