Restart-SCVMHost

Restarts a specified host managed by VMM.

Description

The Restart-SCVMHost cmdlet restarts a specified host managed by System Center Virtual Machine Manager (VMM). Restart-SCVMHost restarts the host by issuing "Power Off" and "Power On" commands.

There are two methods by which you can restart a host: in-band and out-of-band. The default parameter set uses the in-band method. To use the out-of-band method, the host must be configured for out-of-band (OOB) management. For information about configuring the Baseboard Management Controller (BMC) settings for a host, type: "Get-Help Set-SCVMHost -detailed".

For more information about Restart-SCVMHost, type: "Get-Help Restart-SCVMHost -online".

Parameters

VMHost

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts. 

For more information about each type of host, type: "Get-Help Add-SCVMHost -detailed". See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.

Confirm

Required? false
Accept Pipeline Input? false
Position? named
Prompts for confirmation before running the command.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

UseOutOfBandChannel

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the out-of-band management channel should be used to perform the operation. This parameter should be used only when the computer is not responsive.

Examples

1: Restart a specified host.
PS C:\> Get-SCVMHost -ComputerName “NewHost01” | Restart-SCVMHost 
This command restarts the host named NewHost01 using in-band management.
2: Restart a specified host using OOB management.
PS C:\> Get-SCVMHost -ComputerName “NewHost01” | Restart-SCVMHost -UseOutOfBandChannel -Confirm
This command restarts the host named NewHost01 using out-of-band (OOB) management. The command prompts you to confirm the action before proceeding.

Note: The host must be configured for OOB management prior to running this command.

See Also