Stop-MBSBackupPlan
Stop running backup plans.
Stop-MBSBackupPlan
[[-ID] <String>]
[[-Name] <String>]
[[-MasterPassword] <SecureString>]
[<CommonParameters>]
Description
The Stop-MBSBackupPlan cmdlet stop a backup plan with specified ID or Name.
Examples
Example 1: Stop running backup plan by name.
This example stops a backup plan with the name "Backup VMware".
PS C:\>Stop-MBSBackupPlan -Name "Backup VMware"
Example 2: Stop backup plan by the plan ID.
This example stops backup plan with ID ed2e0d37-5ec2-49e1-a381-d2246b3108ec.
PS C:\>Stop-MBSBackupPlan -ID ed2e0d37-5ec2-49e1-a381-d2246b3108ec
Example 3: Stop VMware backup plans with local backup storages type.
This example stops all VMware backup plans with local backup destination which are pipelined from the Get-MBSBackupPlan cmdlet.
PS C:\>Get-MBSBackupPlan -StorageType Local -PlanType VMware | Stop-MBSBackupPlan
Example 4: Stop VMware backup plans with all backup storages type.
This example stop all VMware backup plans pipelined from the Get-MBSBackupPlan cmdlet.
PS C:\>Get-MBSBackupPlan -StorageType All -PlanType VMware | Stop-MBSBackupPlan
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 |
-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[]