NAME
Set-DcsVirtualDiskTemplateProperties
SYNOPSIS
Sets the properties of a specified virtual disk template. Specify the parameters to change in the existing template.
SYNTAX
Set-DcsVirtualDiskTemplateProperties -VirtualDiskTemplate <Object> [ -Name <String> ] [ -VirtualDiskAlias <String> ] [-Tag <String>] [ -FirstPool <String> ] [ -FirstServer <String> ] [ -SecondPool <String> ] [ -SecondServer <String> ] [ -VirtualDiskSize <DataSize> ] [ -VirtualDiskSectorSize <DataSize> ] [ -SnapshotServer <String> ] [ -SnapshotPool <String> ] [ -ContinuousDataProtectionServer <String> ] [ -ContinuousDataProtectionPool <String> ] [ -ContinuousDataProtectionLogSize <DataSize> ] [ -StorageProfile <String> ] [ -UseSequentialStorage <Boolean> ] [ -UseRedundantMirrorMappings <Boolean> ] [-MirrorTrunkMappingEnabled <Boolean>] [-EncryptionEnabled <Boolean>] [-CompressionEnabled <Boolean>] [-DeduplicationEnabled <Boolean>] [-OptimizeStaleOnly <Boolean>] [-StaleDataWeight<UInt32>] [-CyberResiliencyRatingEnabled <Boolean>] [ -AllocationAttentionThreshold <UInt64> ] [ -AllocationWarningThreshold <UInt64> ] [ -AllocationCriticalThreshold <UInt64> ] [ -LatencyAttentionThreshold <UInt64> ] [ -LatencyWarningThreshold <UInt64> ] [ -LatencyCriticalThreshold <UInt64> ] [ -StorageLatencyAttentionThreshold <UInt64> ] [ -StorageLatencyWarningThreshold <UInt64> ] [ -StorageLatencyCriticalThreshold <UInt64> ] [ -ReservedSpacePercentage <UInt32> ] [-VirtualDiskSubType <String>] [-ReadOnly <Boolean>] [ -WriteThroughEnabled <Boolean> ] [ -Connection <String> ] [ -PipelineVariable <String> ] [<CommonParameters>]
DESCRIPTION
Sets the properties of a specified virtual disk template. Specify the parameters to change in the existing template. To create a template, see Add-DcsVirtualDiskTemplate.
PARAMETERS
- -VirtualDiskTemplate<Object>
- VirtualDiskTemplateData object, ID, or name that describes the template.
-
- Required: true
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -Name<String>
- Name of the virtual disk template.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -VirtualDiskAlias<String>
- Name of the virtual disk to create from the template. If multiple virtual disks will be created, the names will begin with the root name and subsequent virtual disks will have a number appended to the end to make them unique. The number will begin with the first available number and will be incremented by one provided that the name is available. numbers will be skipped if they already exist. For instance, if the alias is "VVOLMR" and these names are available, virtual disks will be named "VVOLMR", "VVOLMR 1", "VVOLMR 2", and so on.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -Tag<String>
- Used to tag Virtual Disk Templates for vVol datastores.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -FirstPool<String>
- Name or ID of the disk pool to use as the first storage source of the virtual disks created from the template. To resolve by name, the name must be unique to the server group or the server must be specified.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -FirstServer<String>
- Computer name or ID of the server supplying the first storage source (FirstPool parameter). The computer name must be unique or the name must be fully qualified.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -SecondPool<String>
- Name or ID of the disk pool to use as the second storage source of virtual disks created from this template when mirrored virtual disks will be created. To resolve by name, the name must be unique to the server group or the server must be specified. To remove the pool, use an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -SecondServer<String>
- Computer name or ID of the server supplying the second storage source (SecondPool parameter). The computer name must be unique or the name must be fully qualified. To remove the server, use an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -VirtualDiskSize<DataSize>
- The size of the virtual disk to create from the template. Valid values consist of the number followed by the unit of measurement (MiB, GiB, TiB). Decimals may be used. For example, "100GiB", "1.5TiB", and "500000MiB" are valid sizes. Size can range from a miniumum of 1GiB to a maximum of 1024TiB.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -VirtualDiskSectorSize<DataSize>
- The sector size of the virtual disk to create from the template. Valid values are "512" (bytes), "512B", "4096" (bytes), or "4KB". If no value is set for the template, the default size of 512 bytes will be used.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -SnapshotServer<String>
- Computer name or ID of the server with the preferred snapshot pool (SnapshotPool parameter). The computer name must be unique or the name must be fully qualified. To remove the server, use an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -SnapshotPool<String>
- Name or ID that identifies the preferred snapshot pool. Snapshots of virtual disks created from this template will be created from this pool. To resolve by name, the name must be unique to the server group or the server (SnapshotServer parameter) must be specified. To remove the pool, use an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -ContinuousDataProtectionServer<String>
- Computer name or ID of the server with the pool (ContinousDataProtectionPool parameter) used for the history log. The computer name must be unique or the name must be fully qualified. To remove the server, use an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -ContinuousDataProtectionPool<String>
- Computer name or ID of the server with the pool (ContinousDataProtectionPool parameter) used for the history log. The computer name must be unique or the name must be fully qualified. To remove the pool, use an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -ContinuousDataProtectionLogSize<DataSize>
- The maximum size of the history log for data protection. Valid values consist of the number followed by the unit of measurement (MiB, GiB, TiB). Decimals may be used. For example, "10GiB", "20.5GiB", and "5000MiB" are valid sizes. The history log size can range from a minimum of 8GiB up to 1024TiB. If not specified, the default history log size will be 5% of the size of the CDP-enabled virtual disk or 8GiB, whichever is larger. To remove the size, use "0" or an empty string as the value; for example "".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -StorageProfile<String>
- Use this parameter to set the storage profile. Valid values in order from highest priority to lowest priority are: "Critical", "High", "Normal", "Low", and "Archive". A custom storage profile can also be set.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -UseSequentialStorage<Boolean>
- Use this parameter to enable or disable sequential storage for a virtual disk created from this template. Specify $true to enable or $false to disable sequential storage.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -UseRedundantMirrorMappings<Boolean>
- Use this parameter to enable or disable the redundant mirror paths property for this template. Specify $true to create redundant mirror paths for virtual disks created from this template or $false to disable the redundant mirror paths property. Redundant mirror paths provide two mirror paths going in each direction between servers. Redundant paths can be either iSCSI or Fibre Channel. Each server is required to have two FC or two iSCSI ports with the mirror role enabled (see Set-DcsServerPortProperties). Port paths are automatically selected.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -MirrorTrunkMappingEnabled [<Boolean>]
- Indicates whether or not to use the trunk for mirror paths. Specify $true to use the trunk or $false to not use the trunk. THIS PARAMETER IS FOR DATACORE INTERNAL USE ONLY.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -EncryptionEnabled [<Boolean>]
- Use this parameter to enable or disable the use of Encryption on Virtual Disks created from this template.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -CompressionEnabled [<Boolean>]
- Use this parameter to enable or disable the use of Inline Compression on Virtual Disks created from this template.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -DeduplicationEnabled [<Boolean>]
- Use this parameter to enable or disable the use of Inline Deduplication on Virtual Disks created from this template.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -OptimizeStaleOnly [<Boolean>]
- Use this parameter to enable or disable optimization only for stale data of the virtual disk created from this template. This option can be enabled only when Inline Compression and/or Inline Deduplication are enabled.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -StaleDataWeight <UInt32>
- Use this parameter to specify the Optimization Policy applied to stale data of the virtual disk created from this template. The valid values include "32", "64", and "96". The input is rounded to these valid values. The default value is "64" which specifies the Normal Optimization Policy. Similarly, "32" specifies Lazy and "96" specifies Aggressive Optimization Policy.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -CyberResiliencyRatingEnabled [<Boolean>]
- Use this parameter to specify whether to enable or disable Cyber Resiliency Rating for the virtual disk. Specify $true to enable or $false to disable.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -AllocationAttentionThreshold<UInt64>
- This parameter has been deprecated and will always be empty. This parameter is left in the interface for backwards compatibility. It cannot be changed.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -AllocationWarningThreshold<UInt64>
- This parameter has been deprecated and will always be empty. This parameter is left in the interface for backwards compatibility. It cannot be changed.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -AllocationCriticalThreshold<UInt64>
- This parameter has been deprecated and will always be empty. This parameter is left in the interface for backwards compatibility. It cannot be changed.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -LatencyAttentionThreshold<UInt64>
- This parameter sets the attention level of the Storage Latency Threshold in System Health. The value is the the amount of milliseconds (ms). Valid values are "0" through "60000". The default value is "30". In this case, when the latency for a back-end path to the disk reaches 30 ms, an attention message will be generated.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -LatencyWarningThreshold<UInt64>
- This parameter sets the warning level of the Storage Latency Threshold in System Health. The value is the the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "60". In this case, when the latency for a back-end path to the virtual disk reaches 60 ms, a warning message will be generated.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -LatencyCriticalThreshold<UInt64>
- This parameter sets the critical level of the I/O Latency Threshold in System Health. The value is the the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "120". In this case, when the latency for a front-end path to the virtual disk reaches 120 ms, a critical message will be generated.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -StorageLatencyAttentionThreshold<UInt64>
- This parameter sets the attention level of the Storage Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" through "60000". The default value is "120". In this case, when the latency for a back-end path to the disk reaches 120 ms, an attention level message will be generated. If this parameter is not set, the default value will be used in the template.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -StorageLatencyWarningThreshold<UInt64>
- This parameter sets the warning level of the Storage Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "240". In this case, when the latency for a back-end path to the disk reaches 240 ms, a warning level message will be generated. If this parameter is not set, the default value will be used in the template.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -StorageLatencyCriticalThreshold<UInt64>
- This parameter sets the critical level of the Storage Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "480". In this case, when the latency for a back-end path to the disk reaches 480 ms, a critical level message will be generated. If this parameter is not set, the default value will be used in the template.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -ReservedSpacePercentage<UInt32>
- Use this parameter to reserve a percentage of space in each pool for exclusive use by virtual disks created from the template. A valid value is a number between 0 and 100 which refers to the percentage. For example, to reserve 50% space, enter the value "50". The default setting is "0", which will not reserve any space.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -VirtualDiskSubType<String>
- The subtype of the virtual disk that will be created from the template. Possible values are "Standard", "VVOL", and "ProtocolEndpoint". "Standard" creates a standard virtual disk. "VVOL" creates a virtual volume to use as a storage resource for a VMware virtual machine. "ProtocolEndpoint" creates a protocol endpoint for a VMware virtual volume datastore (storage container). THIS PARAMETER IS FOR DATACORE INTERNAL USE ONLY.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -ReadOnly [<Boolean>]
- Use this parameter to specify if the template should be ReadOnly or not. ReadOnly prevents the template from being changed or deleted. Specify $true to make the template ReadOnly or $false to allow changes to the template. THIS PARAMETER IS FOR DATACORE INTERNAL USE ONLY.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -WriteThroughEnabled<Boolean>
- Specify this parameter to put all virtual disks created from this template in write-through mode (all write operations to the virtual disk are written directly to the back-end storage and then acknowledged).
-
- 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
- <Common Parameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
VirtualDiskTemplateData : Object that identifies the virtual disk template and stores the template information.
OUTPUTS
VirtualDiskTemplateData : Object that identifies and stores the virtual disk template information.
NOTES
Also see Add-DcsVirtualDiskTemplate, Get-DcsVirtualDiskTemplate, Remove-DcsVirtualDiskTemplate.
EXAMPLES
Set-DcsVirtualDiskTemplateProperties -VirtualDiskTemplate "TempMirrorCDP" -Name "TmpltMirrorVOL" -VirtualDiskAlias "MirrorVOL" -ContinuousDataProtectionPool "" -ContinuousDataProtectionLogSize ""
The cmdlet changes the properties set for the template named "TempMirrorCDP". The name is changed to "TmpltMirrorVOL" and the virtual disk alias to "MirrorVOL". The pool used for Continuous Data Protection is removed along with the history log size. This effectively disables Continuous Data Protection and removes the ability for the template.
Alias | : | TmpltMirrorVOL |
VirtualDiskAlias | : | MirrorVOL |
VirtualDiskDescription | : | |
Size | : | 50 GiB |
SectorSize | : | 512 B |
VirtualDiskType | : | MultiPathMirrored |
ReservedSpacePercentage | : | 50 |
FirstDiskPoolId | : | 16E92F64-1A7B-43C8-8FEA-40F508A99B95:{7879824d-5011-11e5-80e4-00155d138904} |
SecondDiskPoolId | : | 8D3DE096-E3B4-427D-B0E1-4EC96C45F6E1:{59db8910-5014-11e5-80e4-00155d138908} |
UseRedundantMirrorMappings | : | True |
ContinuousDataProtectionPoolId | : | |
ContinuousDataProtectionLogSize | : | |
SequentialStorageEnabled | : | False |
StorageProfileId | : | E84B65FF-B69A-4EF1-B79E-71D3DC29E867 |
DefaultSnapshotPoolId | : | 8D3DE096-E3B4-427D-B0E1-4EC96C45F6E1:{59db8910-5014-11e5-80e4-00155d138908} |
AllocatedSpaceThresholdAttention | : | 0 |
AllocatedSpaceThresholdWarning | : | 70 |
AllocatedSpaceThresholdCritical | : | 90 |
LatencyThresholdAttention | : | 0 |
LatencyThresholdWarning | : | 0 |
LatencyThresholdCritical | : | 0 |
VirtualDiskSubType | : | Standard |
ReadOnly | : | False |
WriteThroughEnabled | : | False |
MirrorTrunkMappingEnabled | : | False |
EncryptionEnabled | : | False |
CompressionEnabled | : | False |
DeduplicationEnabled | : | False |
StaleDataEnabled | : | False |
StaleDataWeight | : | 64 |
CyberResiliencyRatingEnabled | : | False |
Sequencenumber | : | 4918 |
Id | : | a8bbfac504c44bd1be074113a3961598 |
Caption | : | |
ExtendedCaption | : | |
Internal | : | False |