Export (0) Print
Expand All
Expand Minimize

Remove-SCVMHostGroup

Updated: September 27, 2012

Applies To: System Center 2012 - Virtual Machine Manager

Remove-SCVMHostGroup

Removes a host group from VMM.

Syntax

Parameter Set: Default
Remove-SCVMHostGroup [-VMHostGroup] <HostGroup> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]




Detailed Description

The Remove-SCVMHostGroup cmdlet removes one or more host group objects from the System Center Virtual Machine Manager (VMM) database. A host group cannot be deleted if it is associated with a private cloud, if it has hosts assigned to it, or if its child host group has hosts assigned to it. This cmdlet will delete child host groups if the host group and its child host groups do not contain any virtual machine hosts.

This cmdlet returns the object upon success (with the MarkedForDeletion property set to TRUE) or returns an error message upon failure.

For more information about Remove-SCVMHostGroup, type: "Get-Help Remove-SCVMHostGroup -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

-VMHostGroup<HostGroup>

Specifies a virtual machine host group object.


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.

Notes

  • Requires a VMM host group object, which can be retrieved by using the Get-SCVMHostGroup cmdlet.

Examples

1: Remove the specified host group.

The first command gets the host group named HostGroup02 and stores it in the $HostGroup variable.

The second command removes the host group object stored in the $HostGroup variable.


PS C:\> $HostGroup = Get-SCVMHostGroup -Name "HostGroup02"PS C:\> Remove-SCVMHostGroup -VMHostGroup $HostGroup

Related topics

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