NAME
Set-DcsVirtualDiskGroupProperties
SYNOPSIS
Sets the alias or description of a virtual disk group, snapshot group, or rollback group.
SYNTAX
Set-DcsVirtualDiskGroupProperties -Group <Object> [ -NewAlias <String> ] [ -Description <String> ] [ -MaxIoOperationsPerSec <UInt64> ] [ -MaxDataTransferredPerSec <DataSize> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Sets the alias or description of a virtual disk group, snapshot group, or rollback group. Specify the parameters to set or change.
PARAMETERS
- -Group<Object>
- The VirtualDiskGroupData object, SnapshotGroupData object, or RollbackGroupData object, name or ID that identifies a virtual disk group, snapshot group, or rollback group.
-
- Required: true
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -NewAlias<String>
- Use this parameter to set a new name for the group.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Description<String>
- Use this parameter to set a description of the group. To remove the description, use an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -MaxIoOperationsPerSec<UInt64>
- The maximum number of operations per second allowed between a set of virtual disks in a virtual disk group and their hosts. The maximum number ranges from 1 to 2,147,483,647. To remove the value in order to disable the setting, set the value to "0".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -MaxDataTransferredPerSec<DataSize>
- The maximum amount of data that can be transferred per second between a set of virtual disks in a virtual disk group and their hosts. Valid values consist of the number followed by the unit of measurement (KB, MiB, GiB). Decimals may be used. For example, "100KB", "500MG", and "2.99GiB" are valid amounts. Maximum amount can range from 1 KB to 3 GiB. To remove the value in order to disable the setting, set the value to "0".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Connection<String>
- Alias of the connection to the server group. If not specified, the default connection will be used.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -PipelineVariable<String>
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
INPUTS
VirtualDiskGroupData, SnapshotData, or RollbackData : Object that identifies the group (virtual disk group, snapshot group, or rollback group).
OUTPUTS
VirtualDiskGroupData, SnapshotGroupData, or RollbackGroupData : Object that identifies and describes he group (virtual disk group, snapshot group, or rollback group).
NOTES
Also see Get-DcsVirtualDiskGroup, Get-DcsSnapshotGroup, Get-DcsRollbackGroup
EXAMPLES
Set-DcsVirtualDiskGroupProperties -Group "VDGroup1 @ 11/17/2011 2:37:38 PM" -NewAlias "VDSnapGrp1 @ 11/17/2011 2:37:38 PM" -Description "Snapshot group of VDGroup1"
Changes the name of the snapshot group named "VDGroup1 @ 11/17/2011 2:37:38 PM" to the new name of "VDSnapGrp1 @ 11/17/2011 2:37:38 PM" and added a description of "Snapshot group of VDGroup1".
ParentGroupId | : | {993a4a47-d76f-4ca4-83a1-8669d436e198} |
Alias | : | VDSnapGrp1 @ 11/17/2011 2:37:38 PM |
Description | : | Snapshot group of VDGroup1 |
Id | : | {ebd1e0e3-65e3-4a47-b6bb-4424058e005e} |
Caption | : | VDSnapGrp1 @ 11/17/2011 2:37:38 PM |
ExtendedCaption | : | VDSnapGrp1 @ 11/17/2011 2:37:38 PM |
Internal | : | False |