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