Restart-SCVMHost
Restart-SCVMHost
Restarts a specified host managed by VMM.
Syntax
Parameter Set: Default
Restart-SCVMHost [-VMHost] <Host> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-UseOutOfBandChannel] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Restart-SCVMHost cmdlet restarts a specified host managed by 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".
Parameters
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UseOutOfBandChannel
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHost<Host>
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.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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.
- Host
- Host[]
Examples
1: Restart a specified host.
This command restarts the host named NewHost01 using in-band management.
PS C:\> Get-SCVMHost -ComputerName “NewHost01” | Restart-SCVMHost
2: Restart a specified host using OOB management.
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.
PS C:\> Get-SCVMHost -ComputerName “NewHost01” | Restart-SCVMHost -UseOutOfBandChannel -Confirm