Get-FileSystemSnapshot
SYNOPSIS
Gets details of the file system snapshots on a PowerStore cluster.
SYNTAX
All (Default)
Get-FileSystemSnapshot [-Cluster] <Cluster> [-Identify] [<CommonParameters>]
ByName
Get-FileSystemSnapshot [-Cluster] <Cluster> [-Name] <String[]> [<CommonParameters>]
ById
Get-FileSystemSnapshot [-Cluster] <Cluster> -Id <String[]> [<CommonParameters>]
ByNasServer
Get-FileSystem [-Cluster] <Cluster> -NasServerId <String[]> [<CommonParameters>]
ByParentId
Get-FileSystem [-Cluster] <Cluster> -ParentId <String[]> [<CommonParameters>]
DESCRIPTION
Gets details of the file system snapshots on a PowerStore cluster. The options include listing all file system snapshots on the cluster, getting file system snapshots by ID, name, NAS server, and parent ID.
CAUTION: There can be more than one file system snapshot on a cluster with the same name. This could lead to unexpected results when piping the output to cmdlets that remove file system snapshots.
EXAMPLES
Example 1
PS C:\> Get-FileSystemSnapshot -Cluster $cluster
Where $cluster is a PowerStore cluster instance. Returns a list of all file system snapshots on the PowerStore cluster.
Example 2
PS C:\> Get-FileSystemSnapshot -Cluster $cluster -Identify
Where $cluster is a PowerStore cluster instance. Returns a list of Identity objects with the ID and name of each file system snapshot on the PowerStore cluster.
Example 3
PS C:\> Get-FileSystemSnapshot -Cluster $cluster -Id id1,id2
Where $cluster is a PowerStore cluster instance. Returns file system snapshots with IDs id1 and id2 on the PowerStore cluster.
Example 4
PS C:\> Get-FileSystemSnapshot -Cluster $cluster -Name name1,name2
Where $cluster is a PowerStore cluster instance. Returns file system snapshots with names name1 and name2 on the PowerStore cluster.
PARAMETERS
-Cluster
The PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
-Id
The file system snapshot ID.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Name
The file system snapshot name.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NasServerId
The NAS server ID.
Type: String[]
Parameter Sets: ByNasServer
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ParentId
The ID of the source file system or clone.
Type: String[]
Parameter Sets: ByParentId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.