Start-MBSBackupPlan
Run backup plans.
Start-MBSBackupPlan
[[-ID] <String>]
[[-Name] <String>]
[-ForceFull]
[[-ForceFullDayOfWeek] <String[]>]
[[-MasterPassword] <SecureString>]
[<CommonParameters>]
Description
The Start-MBSBackupPlan cmdlet runs a backup plan with specified ID or Name.
Examples
Example 1: Start backup plan by name.
This example runs a backup plan with the name "Backup VMware".
PS C:\>Start-MBSBackupPlan -Name "Backup VMware"
Example 2: Start backup plan by the plan ID.
This example runs backup plan with ID ed2e0d37-5ec2-49e1-a381-d2246b3108ec.
PS C:\>Start-MBSBackupPlan -ID ed2e0d37-5ec2-49e1-a381-d2246b3108ec
Example 3: Start VMware backup plans with local backup storages type.
This example runs all VMware backup plans with local backup destination which are pipelined from the Get-MBSBackupPlan cmdlet.
PS C:\>Get-MBSBackupPlan -StorageType Local -PlanType VMware | Start-MBSBackupPlan
Example 4: Start VMware backup plans with all backup storages type.
This example runs all VMware backup plans pipelined from the Get-MBSBackupPlan cmdlet.
PS C:\>Get-MBSBackupPlan -StorageType All -PlanType VMware | Start-MBSBackupPlan
Example 5: Run force full on specific day of the week.
This example runs backup plan in force full mode if today's the day of the week is in the list of specified.
PS C:\>Start-MBSBackupPlan -ID 3a2fde55-9ecd-4940-a75c-d1499b43abda -ForceFull -ForceFullDayOfWeek Friday, Monday
Parameters
-ID
Backup plan ID. Use Get-MBSBackupPlan to list backup plan IDs.
| Type | String |
| Required: | False |
| Position | 1 |
| Default value: | |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Name
Backup plan name. Use Get-MBSBackupPlan to list backup plan names.
| Type | String |
| Required: | False |
| Position | 2 |
| Default value: | |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ForceFull
Run backup plan in force full mode.
| Type | SwitchParameter |
| Required: | False |
| Position | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceFullDayOfWeek
Funs backup plan in force full mode if today's the day of the week is in the list of specified. Requires -ForceFull parameter. Possible vaules: Monday, Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
| Type | String[] |
| Required: | False |
| Position | 3 |
| Default value: | |
| Accept pipeline input: | False |
| 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 | 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.String[]