Share via

Get-SCVMHostGroup

Module:
VirtualMachineManager Module

Gets a host group object from the VMM database.

Syntax

Connection (Default) 

Get-SCVMHostGroup
    [[-Name] <String>]
    [-VMMServer <ServerConnection>]
    [<CommonParameters>]

ID 

Get-SCVMHostGroup
    [[-Name] <String>]
    -ID <Guid>
    [-VMMServer <ServerConnection>]
    [<CommonParameters>]

ParentHostGroup 

Get-SCVMHostGroup
    [[-Name] <String>]
    -ParentHostGroup <HostGroup>
    [<CommonParameters>]

Description

The Get-SCVMHostGroup cmdlet gets one or more host group objects from the Virtual Machine Manager (VMM) database.

For more information about host groups, type Get-Help New-VMHostGroup -Detailed.

Examples

Example 1: Get all host groups at the specified path

PS C:\> Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup01" }

This command gets the host groups located at host path All Hosts\HostGroup01 and displays information about these host groups.

Example 2: Display the name and path properties for all host groups

PS C:\> Get-SCVMHostGroup -VMMServer "VMMServer01.Contoso.com" | select -Property Name,Path

This command gets all host group objects from VMMServer01, selects the name and host group path properties, and displays those properties.

Parameters

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ID
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of a VMM object.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentHostGroup

Specifies the parent host group that contains one or more hosts, host groups, or host clusters.

Parameter properties

Type:HostGroup
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ParentVMHostGroup

Parameter sets

ParentHostGroup
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:ServerConnection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Connection
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.