Share via

Stop-SCVMHost

  • Reference
Module:
VirtualMachineManager

Stops a host managed by VMM.

Syntax

Stop-SCVMHost
    [-VMHost] <Host>
    [-UseOutOfBandChannel]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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 (OOB). The default parameter set uses the in-band method to shut down the host. To use the OOB method, the host must be configured for OOB management. For information about configuring the Baseboard Management Controller (BMC) settings for a host, type Get-Help Set-SCVMHost -Detailed.

Examples

Example 1: Power-off a specified host using in-band management

PS C:\> Get-SCVMHost -ComputerName "NewHost01" | Stop-SCVMHost -Confirm

This command gets the host object named NewHost01 and powers off the host. The command prompts you to confirm the action before proceeding.

Example 2: Power-off a specified host using out-of-band management

PS C:\> Get-SCVMHost -ComputerName "NewHost01" | Stop-SCVMHost -UseOutOfBandChannel -Confirm

This command gets the host object named NewHost01 and powers off the host using OOB management. The command prompts you for confirmation before proceeding.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

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

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-UseOutOfBandChannel

Indicates that the out-of-band management channel should be used to perform the operation. You should use this parameter only when the computer is unresponsive.

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

-VMHost

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, see the Add-SCVMHost cmdlet.

Type:Host
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Host

This cmdlet returns a Host object.