Set-Volume

SYNOPSIS

Modifies a PowerStore volume.

SYNTAX

ByName (Default)

Set-Volume [-Cluster] <Cluster> [-Name] <String> [-NewName <String>] [-Description <String>]
 [-PerformancePolicy <String>] [-ProtectionPolicy <String>] [-RemoveProtectionPolicy]
 [-ReplicationDestination <Boolean>] [-AppType <String>] [-AppTypeOther <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ConfigureMetroByName

Set-Volume [-Cluster] <Cluster> [-Name] <String> [-ConfigureMetro] -RemoteSystemId <String>
 [-RemoteApplianceId <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

EndMetroByName

Set-Volume [-Cluster] <Cluster> [-Name] <String> [-EndMetro] [-DeleteRemoteVolume] [-ForceEndMetro] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ById

Set-Volume [-Cluster] <Cluster> -Id <String> [-NewName <String>] [-Description <String>]
 [-PerformancePolicy <String>] [-ProtectionPolicy <String>] [-RemoveProtectionPolicy]
 [-ReplicationDestination <Boolean>] [-AppType <String>] [-AppTypeOther <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

ConfigureMetroById

Set-Volume [-Cluster] <Cluster> -Id <String> [-ConfigureMetro] -RemoteSystemId <String>
 [-RemoteApplianceId <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

EndMetroById

Set-Volume [-Cluster] <Cluster> -Id <String> [-EndMetro] [-DeleteRemoteVolume] [-ForceEndMetro] [-WhatIf]
 [-Confirm] [<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. Metro session can be configured or removed (Supported from cluster version 3.0.0 and above).

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.

Example 4

PS C:\> Set-Volume -Cluster $cluster -ConfigureMetro -name volName -RemoteSystemId remSys

Where $cluster is a PowerStore cluster instance. Configures the metro session for volume with name volName on remote system with ID remSys.

Example 5

PS C:\> Set-Volume -Cluster $cluster -Endmetro -name volumeName -DeleteRemoteVolume

Where $cluster is a PowerStore cluster instance. Ends the metro session for volume with name volumeName. The DeleteRemoteVolume parameter will delete the target volume.

Example 6

PS C:\> Set-Volume -Cluster $cluster -Endmetro -Id volId -ForceEndMetro

Where $cluster is a PowerStore cluster instance. Ends metro session for volume with ID volId using the force option.

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: True (ByPropertyName, ByValue)
Accept wildcard characters: False

Type: String
Parameter Sets: ConfigureMetroByName, EndMetroByName
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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: True (ByPropertyName)
Accept wildcard characters: False

Type: String
Parameter Sets: ConfigureMetroById, EndMetroById
Aliases:

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

-NewName

New volume name.

Type: String
Parameter Sets: ByName, ById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

New volume description.

Type: String
Parameter Sets: ByName, ById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PerformancePolicy

Performance policy name.

Type: String
Parameter Sets: ByName, ById
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: ByName, ById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoveProtectionPolicy

Remove protection policy.

Type: SwitchParameter
Parameter Sets: ByName, ById
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ReplicationDestination

Indicates if the volume is a replication destination.

Type: Boolean
Parameter Sets: ByName, ById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppType

Application type for the volume.

Type: String
Parameter Sets: ByName, ById
Aliases:

Required: False
Position: Named
Accepted values: RelationalDatabasesOther, RelationalDatabasesOracle, RelationalDatabasesSQLServer, RelationalDatabasesPostgreSQL, RelationalDatabasesMySQL, RelationalDatabasesIBMDB2, BigDataAnalyticsOther, BigDataAnalyticsMongoDB, BigDataAnalyticsCassandra, BigDataAnalyticsSAPHANA, BigDataAnalyticsSpark, BigDataAnalyticsSplunk, BigDataAnalyticsElasticSearch, BusinessApplicationsExchange, BusinessApplicationsSharepoint, BusinessApplicationsOther, BusinessApplicationsERPSAP, BusinessApplicationsCRM, HealthcareOther, HealthcareEpic, HealthcareMEDITECH, HealthcareAllscripts, HealthcareCerner, VirtualizationOther, VirtualizationVirtualServersVSI, VirtualizationContainersKubernetes, VirtualizationVirtualDesktopsVDI, Other

Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppTypeOther

Supplementary field for AppType to contain a custom application type. Can only be used when AppType is an appropriate value (RelationalDatabasesOther, BigAnalyticsOther, Other, etc.)

Type: String
Parameter Sets: ByName, ById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigureMetro

Configure metro session.

Type: SwitchParameter
Parameter Sets: ConfigureMetroByName, ConfigureMetroById
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoteSystemId

The remote system with which the metro relationship will be established.

Type: String
Parameter Sets: ConfigureMetroByName, ConfigureMetroById
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoteApplianceId

A specific remote system appliance to which the volume will be assigned.

Type: String
Parameter Sets: ConfigureMetroByName, ConfigureMetroById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EndMetro

End metro session.

Type: SwitchParameter
Parameter Sets: EndMetroByName, EndMetroById
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeleteRemoteVolume

Delete remote volume.

Type: SwitchParameter
Parameter Sets: EndMetroByName, EndMetroById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForceEndMetro

Force to END Metro session.

Type: SwitchParameter
Parameter Sets: EndMetroByName, EndMetroById
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: False
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: False
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.