Get-HostGroup
SYNOPSIS
Gets details of host groups on the PowerStore cluster.
SYNTAX
All (Default)
Get-HostGroup [-Cluster] <Cluster> [-Identify] [<CommonParameters>]
ByName
Get-HostGroup [-Cluster] <Cluster> [-Name] <String[]> [<CommonParameters>]
ById
Get-HostGroup [-Cluster] <Cluster> -Id <String[]> [<CommonParameters>]
DESCRIPTION
Returns a list of all host groups on the PowerStore cluster. It also provides the ability to query by name and Id.
EXAMPLES
Example 1
PS C:\> Get-HostGroup -Cluster $cluster
Where $cluster is a PowerStore cluster instance. Returns all host groups on the PowerStore cluster.
Example 2
PS C:\> Get-HostGroup -Cluster $cluster -Identify
Where $cluster is a PowerStore cluster instance. Returns a list of Identity objects with the Id and Name of each host group on the PowerStore cluster.
Example 3
PS C:\> Get-HostGroup -Cluster $cluster -Name name1,name2
Where $cluster is a PowerStore cluster instance. Returns full details of the host groups with names name1 and name2.
Example 4
PS C:\> Get-HostGroup -Cluster $cluster -Id uuid1,uuid2
Where $cluster is a PowerStore cluster instance. Returns full details of the host groups with Ids uuid1 and uuid2.
PARAMETERS
-Cluster
A PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identify
Returns Identity objects which contain the Id and Name properties of each entity.
Type: SwitchParameter
Parameter Sets: All
Aliases: List
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
A list of host group names to query.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
A list of host group Ids to query.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.