Get-VolumeGroup
SYNOPSIS
Gets details of volume groups on the PowerStore cluster.
SYNTAX
All (Default)
Get-VolumeGroup [-Cluster] <Cluster> [-Identify] [-Type {Primary | Clone}] [<CommonParameters>]
ByName
Get-VolumeGroup [-Cluster] <Cluster> [-Name] <String[]> [<CommonParameters>]
ById
Get-VolumeGroup [-Cluster] <Cluster> -Id <String[]> [<CommonParameters>]
ByFamilyId
Get-VolumeGroup [-Cluster] <Cluster> -FamilyId <String[]> [-Type {Primary | Clone}] [<CommonParameters>]
ByParentId
Get-VolumeGroup [-Cluster] <Cluster> -ParentId <String[]> [-Type {Primary | Clone}] [<CommonParameters>]
BySourceId
Get-VolumeGroup [-Cluster] <Cluster> -SourceId <String[]> [-Type {Primary | Clone}] [<CommonParameters>]
DESCRIPTION
Provides queries for getting information on primary volume groups and volume group clones. Provides the ability to query by name, Id, family Id, source Id, parent Id, and volume group type.
EXAMPLES
Example 1
PS C:\> Get-VolumeGroup -Cluster $cluster
Where $cluster is a PowerStore cluster instance. Returns all volume groups on the PowerStore cluster.
Example 2
PS C:\> Get-VolumeGroup -Cluster $cluster -Identify
Where $cluster is a PowerStore cluster instance. Returns a list of Identity objects with the Id and Name of each volume group on the PowerStore cluster.
Example 3
PS C:\> Get-VolumeGroup -Cluster $cluster -Type Clone
Where $cluster is a PowerStore cluster instance. Returns all clone volume groups on the PowerStore cluster.
Example 4
PS C:\> Get-VolumeGroup -Cluster $cluster -Id uuid1,uuid2
Where $cluster is a PowerStore cluster instance. Returns full details of the volume groups with Ids uuid1 and uuid2.
Example 5
PS C:\> Get-VolumeGroup -Cluster $cluster -Name name1,name2
Where $cluster is a PowerStore cluster instance. Returns full details of the volume groups with names name1 and name2.
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:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
A list of volume group names.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Id
A list of volume group Ids.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-FamilyId
A list of family Ids.
Type: String[]
Parameter Sets: ByFamilyId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ParentId
A list of parent Ids.
Type: String[]
Parameter Sets: ByParentId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-SourceId
A list of source Ids.
Type: String[]
Parameter Sets: BySourceId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Type
Filter results by volume group type.
Type: String
Parameter Sets: All, ByFamilyId, ByParentId, BySourceId
Aliases:
Accepted values: Primary, Clone
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.