Skip to content

Latest commit

 

History

History
134 lines (101 loc) · 3.16 KB

Restart-HcsController.md

File metadata and controls

134 lines (101 loc) · 3.16 KB
external help file Module Name ms.date online version schema title
Microsoft.HCS.Management.dll-Help.xml
HCS
12/05/2017
2.0.0
Restart-HcsController

Restart-HcsController

SYNOPSIS

Restarts a controller.

SYNTAX

Restart-HcsController [-ControllerId <ControllerIds>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Restart-HcsController cmdlet restarts a controller. If you run the cmdlet without any parameters, it restarts the current controller. The current controller is the controller where you run the cmdlet. You can use the ControllerID parameter to specify a different controller to restart.

EXAMPLES

Example 1: Restart a controller

PS C:\> Restart-HcsController -ControllerId 0
Checking device state...

This command will restart your standby controller.
Are you sure you want to continue with this operation?
[Y] Yes  [N] No  [?] Help (default is "Y"): y

This command restarts the controller specified by the ControllerID parameter. In this example, controller0 is the standby controller.

Example 2: Restart the current controller

PS C:\> Restart-HcsController

Checking device state...

This command will restart your active controller. Restarting the active controller will cause a failover to the standby
controller.
Are you sure you want to continue with this operation?
[Y] Yes  [N] No  [?] Help (default is "Y"): n

This command restarts the current controller. In this example, the controller is the active controller. The current controller does not have to be the active controller.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ControllerId

Specifies controller0 or controller1.

Type: ControllerIds
Parameter Sets: (All)
Aliases: 
Accepted values: Controller0, Controller1

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Stop-HcsController