NAME

Add-DcsVirtualDiskFromTemplate

SYNOPSIS

Creates a virtual disk from a virtual disk template.

SYNTAX

Add-DcsVirtualDiskFromTemplate   -VirtualDiskTemplate <Object>   [ -Name <String> ]   [ -Description <String> ]   [ -Size <DataSize> ]   [ -SectorSize <DataSize> ] [-VirtualDiskSubType <String>]  [ -Count <UInt32> ]  [-MirrorTrunkMappingEnabled<Boolean>] [-EncryptionEnabled <Boolean>] [-CompressionEnabled <Boolean>] [-DeduplicationEnabled <Boolean>] [-OptimizeStaleOnly <Boolean>] [-StaleDataWeight <UInt32>] [-CyberResiliencyRatingEnabled <Boolean>] [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ] [<CommonParameters>]

DESCRIPTION

Creates a virtual disk from a virtual disk template. Some parameters are provided which can override settings in the specified template. (See Add-DcsVirtualDiskTemplate to create a template. )

PARAMETERS

-VirtualDiskTemplate<Object>
VirtualDiskTemplateData object, ID, or name that describes the template to use when creating the virtual disks.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Name<String>
Name of the virtual disk to create. If specified and multiple virtual disks will be created, the names 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 1", "VVOLMR 2" and so on.If this parameter is not specified, the virtual disk alias, supplied when the template was created, will be used as the root of the name.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the new virtual disks.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Size<DataSize>
The size of the virtual disk to create. If specified, this parameter will override the virtual disk size set in 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

-SectorSize<DataSize>
The sector size of the virtual disk. If specified, this parameter will override the sector size set in the template. Valid values are "512", "512B", "4096", or "4KB". Values "512" and "4096" are the number of bytes.

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. If specified, this parameter will override the virtual disk subtype set in 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).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false
 
-Count<UInt32>
The number of virtual disks to create. If not specified, one virtual disk will be created.


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
 
-AssignToCurrentUser<SwitchParameter>
Use this parameter to assign exclusive ownership to the user account currently logged in. This restricts all operations on the virtual disks being created to only the authenticated user for the current PowerShell session.

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
 
-<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk. One object is returned for each virtual disk created.

NOTES

Also see Add-DcsVirtualDiskFromVirtualDisk, which creates a virtual disk using the properties of another virtual disk.

EXAMPLES


-------------- Example 1 Creates two virtual disks from a specified template. --------------
Add-DcsVirtualDiskFromTemplate -VirtualDiskTemplate "MR_100" -SectorSize 4KB -AssignToCurrentUser Count 2
		

The cmdlet is invoked to create two virtual disks from the template named "MR_100 with the specified sector size of 4KB and assign both virtual disks to the logged in user performing the operation. The parameter SectorSize was included to override the setting in the template.

VirtualDiskGroupId:
FirstHostId:AF7412B4-5320-4FEC-98E4-E90ED9C9BF6B
SecondHostId:692CED43-5AE3-4CEA-87E7-7D9B4E77F180
BackupHostId:
StorageProfileId:100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId:
Alias:MR_100_
Description:Creates mirrored virtual disk 100 GiB
Size:100 GiB
SectorSize:4 KB
Type:MultiPathMirrored
DiskStatus:Offline
InquiryData:DataCore Virtual Disk DCS f4d633ec8c754689a135ac9ad1327211
ScsiDeviceId:{96, 3, 13, 144...}
ScsiDeviceIdString:60030D9067323B07586CCE3DC06BED8E
RemovableMedia:False
WriteThrough:False
Offline:False
Disabled:False
ManualRecovery:False
DiskLayout:DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled:True
RecoveryPriority:Regular
TPThresholdsEnabled:False
IsServed:False
SubType:Standard
MirrorTrunkMappingEnabled:True
EncryptionEnabled:False
CompressionEnabled:False
DeduplicationEnabled:False
StaleDataEnabled:False
StaleDataWeight:64
CyberResiliencyRatingEnabled:False
Sequencenumber:640889
Id:f4d633ec8c754689a135ac9ad1327211
Caption:MR_100_
ExtendedCaption:MR_100_ from Server Group 1
Internal:False
   
VirtualDiskGroupId:
FirstHostId:AF7412B4-5320-4FEC-98E4-E90ED9C9BF6B
SecondHostId:692CED43-5AE3-4CEA-87E7-7D9B4E77F180
BackupHostId:
StorageProfileId:100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId:
Alias:MR_100_1
Description:Creates mirrored virtual disk 100 GiB
Size:100 GiB
SectorSize:4 KB
Type:MultiPathMirrored
DiskStatus:Offline
InquiryData:DataCore Virtual Disk DCS 9df40c31b39e4a65bbadc86725b25ee6
ScsiDeviceId:{96, 3, 13, 144...}
ScsiDeviceIdString:60030D9032333B078DF1AC38A4E7119E
RemovableMedia:False
WriteThrough:False
Offline:False
Disabled:False
ManualRecovery:False
DiskLayout:DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled:True
RecoveryPriority:Regular
TPThresholdsEnabled:False
IsServed:False
SubType:Standard
MirrorTrunkMappingEnabled:True
EncryptionEnabled:False
CompressionEnabled:False
DeduplicationEnabled:False
StaleDataEnabled:False
StaleDataWeight:64
Sequencenumber:640890
Id:9df40c31b39e4a65bbadc86725b25ee6
Caption:MR_100_1
ExtendedCaption:MR_100_1 from Server Group 1
Internal:False