NAME

Set-DcsVirtualDiskProperties

SYNOPSIS

Sets the properties of a virtual disk.

SYNTAX

Set-DcsVirtualDiskProperties [-Alias <String>] [-Description <String>] [-RecoveryPriority <String>] -VirtualDisk <Object> [-WriteThrough <Boolean>] [-StorageProfile <String>] [-EncryptionEnabled <Boolean>] [-NVMe <Boolean>] [-NVMeNamespaceId <UInt64>] [-MirrorTrunkMappingEnabled <Boolean>] [-EnableTPThresholds <Boolean>] [-CyberResilienceRatingEnabled <Boolean>] [-PreferredServer <String>] [-Connection <String>] [-PipelineVariable <String>] [<CommonParameters>]

DESCRIPTION

Sets the properties of a virtual disk. Specify the parameters to set or change. (See Notes for other cmdlets related to virtual disk settings.)

PARAMETERS

-Alias<String>

Use this parameter to change the name of the virtual disk.

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 virtual disk. 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

-RecoveryPriority<String>

The RecoveryPriority parameter is obsolete and the parameter is only included for backward compatibility. The mirror recovery priority is included as part of the storage profile for a virtual disk. To change the setting for storage profile, see the StorageProfile parameter.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-VirtualDisk<Object>

VirtualDiskData object, name, or ID that identifies the virtual disk.

Required: true

Position: named

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-WriteThrough [<Boolean>]

Use this parameter to specify whether to enable or disable cache write-through for the virtual disk. Specify $true to enable cache write-through or $false to disable cache write-through. When enabled, all write operations to the virtual disk are written directly to the back-end storage and then acknowledged. This setting is disabled by default.

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

-EncryptionEnabled [<Boolean>]

Use this parameter to specify whether to enable or disable encryption setting for the virtual disk. Specify $true to enable encryption or $false to disable encryption.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-NVMe [<Boolean>]

Use this parameter to specify whether to enable or disable NVMe setting for the virtual disk. Specify $true to enable NVMe or $false to disable NVMe.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-NVMeNamespaceId [<UInt64>]

Use this parameter to specify the NVMe Namespace ID of the virtual disk.

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.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-EnableTPThresholds [<Boolean>]

THIS PARAMETER IS FOR DATACORE INTERNAL USE ONLY. Use this parameter to enable or disable thin provisioning thresholds. Specify $true to enable or $false to disable

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

-PreferredServer<String>

Use this parameter to set the preferred server that should handle I/O requests from the client (host). The computer name or ID of the server must be unique, or the name must be fully qualified.

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 is 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

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

NOTES

This cmdlet requires virtual disk privileges. To change rollback properties, rollback privileges are also required. To change snapshot properties, snapshot privileges are also required. For user accounts without virtual disk privileges, see Set-DcsRollbackProperties to set rollback properties and see Set-DcsSnapshotProperties to set snapshot properties. Also see related cmdlets: Set-DcsVirtualDiskSize, Get-DcsVirtualDisk, Set-DcsVirtualDiskScsiId, Set-DcsStorageProfileProperties, Enable-DcsVirtualDiskAutoRecovery, Disable-DcsVirtualDiskAutoRecovery, Set-DcsVirtualDiskWitnessProperties.

EXAMPLES

Set-DcsVirtualDiskProperties -VirtualDisk "Virtual disk 1" -StorageProfile "Storage profile 1"
		

Get-DcsVirtualDisk -ServerGroup "Local Group" -Kind Standard, Rollback | Set-DcsVirtualDiskProperties -WriteThrough $true