Get-VolumeGroupSnapshot
SYNOPSIS
Gets details of PowerStore volume group snapshots.
SYNTAX
All (Default)
Get-VolumeGroupSnapshot [-Cluster] <Cluster> [-Identify] [<CommonParameters>]
ByName
Get-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String[]> [<CommonParameters>]
ByNameVolumeGroupName
Get-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String[]> -VolumeGroupName <String[]> [<CommonParameters>]
ByNameVolumeGroupId
Get-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String[]> -VolumeGroupId <String[]> [<CommonParameters>]
ById
Get-VolumeGroupSnapshot [-Cluster] <Cluster> -Id <String[]> [<CommonParameters>]
ByVolumeGroupName
Get-VolumeGroupSnapshot [-Cluster] <Cluster> -VolumeGroupName <String[]> [<CommonParameters>]
ByVolumeGroupId
Get-VolumeGroupSnapshot [-Cluster] <Cluster> -VolumeGroupId <String[]> [<CommonParameters>]
ByFamilyId
Get-VolumeGroupSnapshot [-Cluster] <Cluster> -FamilyId <String[]> [<CommonParameters>]
DESCRIPTION
Provides queries for getting information on volume group snapshots. Provides the ability to query by Id, name, volume group Id/name, and family Id.
EXAMPLES
Example 1
PS C:\> Get-VolumeGroupSnapshot -Cluster $cluster
Where $cluster is a PowerStore cluster instance. Gets all volume group snapshots on the PowerStore cluster.
Example 2
PS C:\> Get-VolumeGroupSnapshot -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 snapshot on the PowerStore cluster.
Example 3
PS C:\> Get-VolumeGroupSnapshot -Cluster $cluster -Id uuid1,uuid2
Where $cluster is a PowerStore cluster instance. Gets volume group snapshot details for the snapshots with Ids uuid1 and uuid2.
Example 4
PS C:\> Get-VolumeGroupSnapshot -Cluster $cluster -Name name1,name2
Where $cluster is a PowerStore cluster instance. Gets volume group snapshot details for the snapshots with names name1 and name2.
Example 5
PS C:\> Get-VolumeGroupSnapshot -Cluster $cluster -VolumeGroupId uuid1,uuid2
Where $cluster is a PowerStore cluster instance. Gets all snapshots for volume group with Id uuid1 and uuid2.
Example 6
PS C:\> Get-VolumeGroupSnapshot -Cluster $cluster -VolumeGroupName name1
Where $cluster is a PowerStore cluster instance. Gets all snapshots for volume group with name name1.
Example 7
PS C:\> Get-VolumeGroupSnapshot -Cluster $cluster -Name name1 -VolumeGroupName vgname1
Where $cluster is a PowerStore cluster instance. Gets the snapshot with name name1 of source volume group with name vgname1.
Example 8
PS C:\> Get-VolumeGroupSnapshot -Cluster $cluster -Name name1 -VolumeGroupId uuid1
Where $cluster is a PowerStore cluster instance. Gets the snapshot with name name1 of source volume group with Id uuid1.
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 volume group snapshot names.
Type: String[]
Parameter Sets: ByName, ByNameVolumeGroupId, ByNameVolumeGroupName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
A list of volume group snapshot Ids.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-VolumeGroupName
A list of source volume group names.
Type: String[]
Parameter Sets: ByVolumeGroupName, ByNameVolumeGroupName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeGroupId
A list of source volume group Ids.
Type: String[]
Parameter Sets: ByVolumeGroupId, ByNameVolumeGroupId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
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: 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.