Set-VolumeGroup
SYNOPSIS
Modifies properties of a volume group.
SYNTAX
ModifyPropertiesByName (Default)
Set-VolumeGroup [-Cluster] <Cluster> [-Name] <String> [-NewName <String>] [-Description <String>]
[-ProtectionPolicy <String>] [-RemoveProtectionPolicy] [-ReplicationDestination <Boolean>]
[-WriteOrderConsistent <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
AddMembersByName
Set-VolumeGroup [-Cluster] <Cluster> [-Name] <String> [-VolumeNamesToAdd <String[]>] [-VolumeIdsToAdd <String[]>]
[-Confirm] [-WhatIf] [<CommonParameters>]
RemoveMembersByName
Set-VolumeGroup [-Cluster] <Cluster> [-Name] <String> [-VolumeNamesToRemove <String[]>]
[-VolumeIdsToRemove <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
ModifyPropertiesById
Set-VolumeGroup [-Cluster] <Cluster> -Id <String> [-NewName <String>] [-Description <String>]
[-ProtectionPolicy <String>] [-RemoveProtectionPolicy] [-ReplicationDestination <Boolean>]
[-WriteOrderConsistent <Boolean>] [-Confirm] [-WhatIf] [<CommonParameters>]
AddMembersById
Set-VolumeGroup [-Cluster] <Cluster> -Id <String> [-VolumeNamesToAdd <String[]>] [-VolumeIdsToAdd <String[]>]
[-Confirm] [-WhatIf] [<CommonParameters>]
RemoveMembersById
Set-VolumeGroup [-Cluster] <Cluster> -Id <String> [-VolumeNamesToRemove <String[]>]
[-VolumeIdsToRemove <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Provides the ability to change properties of a volume group, add volumes to, or removes volumes from the volume group.
EXAMPLES
Example 1
PS C:\> Set-VolumeGroup -Cluster $cluster -Name volgroup -NewName volgroup-renamed -Description "Renamed volume group"
Where $cluster is a PowerStore cluster instance. Renames the volume group volgroup with a new name volgroup-renamed and sets the description to “Renamed volume group”.
Example 2
PS C:\> Set-VolumeGroup -Cluster $cluster -Name volgroup -ProtectionPolicy policy1
Where $cluster is a PowerStore cluster instance. Sets the protection policy of volgroup to policy1.
Example 3
PS C:\> Set-VolumeGroup -Cluster $cluster -Name volgroup -RemoveProtectionPolicy
Where $cluster is a PowerStore cluster instance. Removes the protection policy association from the volume group.
Example 4
PS C:\> Set-VolumeGroup -Cluster $cluster -Name volgroup -VolumeNamesToAdd vol1,vol2
Where $cluster is a PowerStore cluster instance. Adds volumes with names vol1, and vol2 to the volume group.
Example 5
PS C:\> Set-VolumeGroup -Cluster $cluster -Name volgroup -VolumeNamesToRemove vol1,vol2
Where $cluster is a PowerStore cluster instance. Removes volumes with names vol1, and vol2 from the volume group.
Example 6
PS C:\> Set-VolumeGroup -Cluster $cluster -Name volgroup -VolumeIdsToAdd id1,id2
Where $cluster is a PowerStore cluster instance. Adds volumes with Ids id1, and id2 to the volume group.
Example 7
PS C:\> Set-VolumeGroup -Cluster $cluster -Name volgroup -VolumeIdsToRemove id1,id2
Where $cluster is a PowerStore cluster instance. Removes volumes with Ids id1, and id2 from the volume group.
PARAMETERS
-Cluster
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 group name.
Type: String
Parameter Sets: ModifyPropertiesByName, AddMembersByName, RemoveMembersByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Volume group Id.
Type: String
Parameter Sets: ModifyPropertiesById, AddMembersById, RemoveMembersById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewName
New volume group name.
Type: String
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Volumg group description.
Type: String
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProtectionPolicy
Protection policy name.
Type: String
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RemoveProtectionPolicy
Switch to remove the current protection policy.
Type: SwitchParameter
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReplicationDestination
Indicates if the volume group is a replication destination.
Type: Boolean
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WriteOrderConsistent
Indicates if the volume group is write order consistent.
Type: Boolean
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeNamesToAdd
List of volume names to add.
Type: String[]
Parameter Sets: AddMembersById, AddMembersByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeIdsToAdd
List of volume Ids to add.
Type: String[]
Parameter Sets: AddMembersById, AddMembersByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeNamesToRemove
List of volume names to remove.
Type: String[]
Parameter Sets: RemoveMembersById, RemoveMembersByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeIdsToRemove
List of volume Ids to remove.
Type: String[]
Parameter Sets: RemoveMembersById, RemoveMembersByName
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.