Get-Volume

SYNOPSIS

Gets details of volumes on the PowerStore cluster.

SYNTAX

All (Default)

Get-Volume [-Cluster] <Cluster> [-Identify] [-Type {Primary | Clone}] [<CommonParameters>]

ByVolumeName

Get-Volume [-Cluster] <Cluster> [-Name] <String[]> [<CommonParameters>]

ByVolumeId

Get-Volume [-Cluster] <Cluster> -Id <String[]> [<CommonParameters>]

ByVolumeGroupName

Get-Volume [-Cluster] <Cluster> -VolumeGroup <String[]> [<CommonParameters>]

ByFamilyId

Get-Volume [-Cluster] <Cluster> -FamilyId <String[]> [-Type {Primary | Clone}] [<CommonParameters>]

ByParentId

Get-Volume [-Cluster] <Cluster> -ParentId <String[]> [-Type {Primary | Clone}] [<CommonParameters>]

BySourceId

Get-Volume [-Cluster] <Cluster> -SourceId <String[]> [-Type {Primary | Clone}] [<CommonParameters>]

DESCRIPTION

Provides queries for getting information on primary volumes and clones. Provides the ability to query by name, Id, family Id, source Id, parent Id, volume group, and volume type.

EXAMPLES

Example 1

PS C:\> Get-Volume -Cluster $cluster

Where $cluster is a PowerStore cluster instance. Returns all volumes on the PowerStore cluster.

Example 2

PS C:\> Get-Volume -Cluster $cluster -Identify

Where $cluster is a PowerStore cluster instance. Returns a list of Identity objects with the Id and Name of each volume on the PowerStore cluster.

Example 3

PS C:\> Get-Volume -Cluster $cluster -Type Clone

Where $cluster is a PowerStore cluster instance. Returns all clone volumes on the PowerStore cluster.

Example 4

PS C:\> Get-Volume -Cluster $cluster -Id uuid1,uuid2

Where $cluster is a PowerStore cluster instance. Returns full details of the volumes with Ids uuid1 and uuid2.

Example 5

PS C:\> Get-Volume -Cluster $cluster -Name name1,name2

Where $cluster is a PowerStore cluster instance. Returns full details of the volumes with names name1 and name2.

Example 6

PS C:\> Get-Volume -Cluster $cluster -VolumeGroup vg1,vg2

Where $cluster is a PowerStore cluster instance. Returns volumes associated with volume group names vg1 and vg2.

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 names.

Type: String[]
Parameter Sets: ByVolumeName
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Id

A list of volume Ids.

Type: String[]
Parameter Sets: ByVolumeId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-VolumeGroup

Filter results by volume group.

Type: String[]
Parameter Sets: ByVolumeGroupName
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 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.

INPUTS

System.String[]

OUTPUTS

Dell.PowerStore.Management.Model.Volume

Dell.PowerStore.Management.Model.Identity

NOTES

Getting all volumes on the cluster will return a significant amount of data if the cluster has a lot of volumes and the volumes are mapped to many hosts. Performance may be impacted so it may be more efficient to query a subset of volumes or use the -Identify option to get an initial list of Id,Name pairs for further processing.

RELATED LINKS