Export (0) Print
Expand All
Expand Minimize

Stop-SCVMHost

Updated: September 27, 2012

Applies To: System Center 2012 - Virtual Machine Manager

Stop-SCVMHost

Stops a host managed by VMM.

Syntax

Parameter Set: Default
Stop-SCVMHost [-VMHost] <Host> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-UseOutOfBandChannel] [ <CommonParameters>]




Detailed Description

The Stop-SCVMHost cmdlet stops a host managed by System Center 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".

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

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

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: Power off a specified host using in-band management

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


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

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

This command gets the host object named NewHost01 and 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

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft