Set-HcsBackupApplianceMode
Set-HcsBackupApplianceMode
Sets the toggle for the backup appliance mode. The backup appliance mode is used to deploy backup target workloads on the StorSimple device.
Syntax
Parameter Set: DisableParameterSet
Set-HcsBackupApplianceMode [-Disable] [ <CommonParameters>]
Parameter Set: EnableParameterSet
Set-HcsBackupApplianceMode [-Enable] [ <CommonParameters>]
Detailed Description
The Set-HCSBackupApplianceMode cmdlet sets the appliance mode status.
To query the current status of the device, use the Get- HCSBackupApplianceMode cmdlet. For more information, see the Get-HcsBackupApplianceMode cmdlet.
Parameters
-Disable
Indicates that this cmdlet disables Backup Appliance mode.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Enable
Indicates that this cmdlet enables Backup Appliance mode.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get the backup appliance mode
This command gets the backup appliance mode of the device.
PS C:\> Set-HcsBackupApplianceMode -Enable