Stop-SCVMHost
Stop-SCVMHost
Stops a host managed by VMM.
Syntax
Parameter Set: Default
Stop-SCVMHost [-VMHost] <Host> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-UseOutOfBandChannel] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Stop-SCVMHost cmdlet stops a host managed by Virtual Machine Manager (VMM) by issuing a Power Off command.
There are two methods by which you can stop a host: in-band and out-of-band. The default parameter set uses the in-band method to shut down the host. 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 Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit 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 this cmdlet uses the out-of-band management channel to perform the operation. Use this parameter 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.
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
Example 1: Power off a specified host using in-band management
This command gets the host object named NewHost01, and then powers off the host. The command prompts you to confirm the action before proceeding.
PS C:\> Get-SCVMHost -ComputerName "NewHost01" | Stop-SCVMHost -Confirm
Example 2: Power off a specified host using out-of-band management
This command gets the host object named NewHost01, and then powers off the host using out-of-band management. The command prompts you for confirmation before proceeding.
PS C:\> Get-SCVMHost -ComputerName "NewHost01" | Stop-SCVMHost -UseOutOfBandChannel -Confirm