Set-Volume
SYNOPSIS
Modifies a PowerStore volume.
SYNTAX
ByName (Default)
Set-Volume [-Cluster] <Cluster> [-Name] <string> [-NewName <string>] [-Description <string>] [-PerformancePolicy {Low | Medium | High}]
[-ProtectionPolicy <string>] [-RemoveProtectionPolicy] [-ReplicationDestination <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
ById
Set-Volume [-Cluster] <Cluster> -Id <string> [-NewName <string>] [-Description <string>] [-PerformancePolicy {Low | Medium | High}]
[-ProtectionPolicy <string>] [-RemoveProtectionPolicy] [-ReplicationDestination <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Volume name, description, performance policy, and protection policy can be modified. Protection policy can be removed and replication destination can be changed. If the volume is not a replication destination, changing it to a replication destination is not allowed.
EXAMPLES
Example 1
PS C:\> Set-Volume -Cluster $cluster -Name volume1 -NewName volume2
Where $cluster is a PowerStore cluster instance. Updates volume name from volume1 to volume2.
Example 2
PS C:\> Set-Volume -Cluster $cluster -Id volumeId -PerformancePolicy Low -RemoveProtectionPolicy
Where $cluster is a PowerStore cluster instance. Sets performance policy to low and removes existing protection policy for the given volume Id.
Example 3
PS C:\> Set-Volume -Cluster $cluster -Name volume1 -Description 'volume1 desc' -PerformancePolicy Low -RemoveProtectionPolicy
Where $cluster is a PowerStore cluster instance. Updates volume description, sets performance policy to low and removes existing protection policy.
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
-Name
Volume name.
Type: String
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Unique identifier of volume.
Type: String
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewName
New volume name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
New volume description.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PerformancePolicy
Performance policy name.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Low, Medium, High
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProtectionPolicy
Protection policy name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RemoveProtectionPolicy
Remove protection policy.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReplicationDestination
Indicates if the volume is a replication destination.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
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.