Skip to main content
SnapCenter 4.7 cmdlets

New-SdVolume

Contributors

Provisions volumes using templates that encapsulate best practices for provisioning volumes for different types of applications.

Syntax

New-SdVolume [-Name]  <String>  [-Aggregate]  <String>  [-Size]  <String>  [-JunctionPath]  <String>  [-StorageSystem]  <String>  [-TemplateName]  <String>  [-Comment]  <String>  [-AntivirusOnAccessPolicy]  <String>  [-ExportPolicy]  <String>  [-FlexCacheCachePolicy]  <String>  [-FlexCacheFillPolicy]  <String>  [-FlexCacheOriginVolume]  <String>  [-GroupId]  <Int32>  [-IndexDirectoryFormat]  <Boolean>  [-JunctionActive]  <Boolean>  [-MaxDirectorySize]  <Decimal>  [-NvFailEnabled]  <Boolean>  [-SecurityStyle]  <String>  [-SnapshotPolicy]  <String>  [-State]  <String>  [-Type]  <String>  [-UnixPermissions]  <String>  [-UserId]  <Int32>  [-VirtualStorageServerRoot]  <Boolean>  [-QosPolicyGroup]  <String>  [-SnapshotCloneDependency]  <Boolean>  [-EnableSnapdiff]  <Boolean>  [-SchedSnapName]  <String>  [-SpaceGuarantee]  <String>  [-SnapReserve]  <Int32>  [-FractionalReserve]  <Int32>  [-SpaceMgmtTryFirst]  <String>  [-SpaceNearlyFullThresholdPercent]  <Int32>  [-SpaceFullThresholdPercent]  <Int32>  [-Files]  <Int32>  [-FilesysSizeFixed]  <>  [-ExtentEnabled]  <String>  [-ReadRealloc]  <String>  [-ExternalCache]  <String>  [-VmAlignSector]  <Int32>  [-VmAlignSuffix]  <String>  [-AutoSizeMode]  <String>  [-MaxAutosize]  <String>  [-AutosizeIncrement]  <String>  [-AutosizeIncrementPercent]  <Int32>  [-MinAutosize]  <String>  [-AutosizeGrowThresholdPercent]  <Int32>  [-AutosizeShrinkThresholdPercent]  <Int32>  [-AutoDeleteEnabled]  <>  [-Commitment]  <String>  [-DeferDelete]  <String>  [-Deleteorder]  <String>  [-DeferDeletePrefix]  <String>  [-TargetFreeSpace]  <Int32>  [-Trigger]  <String>  [-DestroyList]  <String>  [-Session]  <String>  [-Host]  <String>

Detailed Description

Provisions volumes using templates that encapsulate best practices for provisioning volumes for different types of applications. Gets the provisioning templates from the "templates" folder in your install directory. This cmdlet is supported in clustered Data ONTAP 8.2 and later.Related cmdlets: Remove-SdVolume

Parameters

Name Description Required? Pipeline Input Default Value

Name

Indicates the name of the new volume.

false

true (ByPropertyName)

Aggregate

Specifies the name of the containing aggregate.

false

true (ByPropertyName)

Size

Designates the size of the new volume.

false

true (ByPropertyName)

JunctionPath

Specifies the junction path at which this volume is to be mounted.

false

true (ByPropertyName)

StorageSystem

Specifies the storage virtual machine for provisioning the storage volume.

false

true (ByPropertyName)

TemplateName

Indicates the name of the provisioning template. You should qualify path to the template if the template resides in a folder other than SnapDrive Templates folder.

false

true (ByPropertyName)

Comment

Provides a description for the volume being created.

false

true (ByPropertyName)

AntivirusOnAccessPolicy

Specifies the name of the Anti-Virus On-Access policy.The default policy name is 'default'.

false

true (ByPropertyName)

ExportPolicy

Specifies the name of the export policy to be used by NFS/SMB protocols.The default policy name is 'default'.

false

true (ByPropertyName)

FlexCacheCachePolicy

Specifies the name of the FlexCache cache policy.The default policy name is 'default'.

false

true (ByPropertyName)

FlexCacheFillPolicy

Specifies the name of the FlexCache prefill policy.The default policy name is 'default'

false

true (ByPropertyName)

FlexCacheOriginVolume

Specifies the name of the origin volume that contains the authoritative data.

false

true (ByPropertyName)

GroupId

Specifies the UNIX group ID for the volume.The default value is 0 ('root').

false

true (ByPropertyName)

IndexDirectoryFormat

Indicates whether you want to enable the index directory format. If true, index directory format is enabled.The default is false.

false

true (ByPropertyName)

JunctionActive

Indicates whether the mounted volume is accessible.The default is true.

false

true (ByPropertyName)

MaxDirectorySize

Specifies the maximum size in bytes, to which any directory in this volume can grow.

false

true (ByPropertyName)

NvFailEnabled

Indicates whether you want the controller to identify and attempt to correct NVRAM failure errors. If true, the controller performs additional work at startup and takeover times, if it finds that there has been any potential data loss in this volume due to an NVRAM failure.

false

true (ByPropertyName)

SecurityStyle

Designates a volume security style.Possible values are: mixed, ntfs, unix.

false

true (ByPropertyName)

SnapshotPolicy

Specifies the Snapshot copy policy.Default policy is 'default'.

false

true (ByPropertyName)

State

Indicates the desired state of the volume after it is created.Possible values are: online|restricted|offline|force-online|force-offline|mixed

false

true (ByPropertyName)

Type

Specifies the volume type.Possible values are: rw, ls, dp, dc.

false

true (ByPropertyName)

UnixPermissions

Indicates the UNIX permission bits in an octal string format.

false

true (ByPropertyName)

UserId

Specifies the UNIX user ID for the volume. The default value is 0 ('root').

false

true (ByPropertyName)

VirtualStorageServerRoot

Indicates whether you want this value to be the namespace root volume. If true, this volume is the namespace root volume of the virtual storage server which owns this volume.The default value is false.

false

true (ByPropertyName)

QosPolicyGroup

Optionally specifies which QoS policy group to apply to the volume. This policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a volume, the system monitors and controls the traffic to the volume. To remove this volume from a policy group, enter the reserved keyword 'none'. This parameter is not supported on Infinite Volumes.

false

true (ByPropertyName)

SnapshotCloneDependency

{on|off}] - Snapshot Cloning DependencySpecifies whether the LUN clone dependancy on Snapshot copies is enabled. If set to on, LUN clone dependency on Snapshot copies is enabled. This parameter is not supported on Infinite Volumes.

false

true (ByPropertyName)

EnableSnapdiff

{true|false}] - Create Namespace Mirrors For Snapdiff Use

false

true (ByPropertyName)

SchedSnapName

{create_time|ordinal}] - Naming Scheme for Automatic SnapshotsSpecifies the naming convention for automatic Snapshot copies. If set to create-time, automatic Snapshot copies are named using the format <schedule_name>.yyyy-mm-dd_hhmm. Example: hourly.2010-04-01_0831. If set to ordinal, automatic Snapshot copies are named using the format <schedule_name>.<n>. Example: hourly.3This parameter is not supported on Infinite Volumes.

false

true (ByPropertyName)

SpaceGuarantee

Specifies the type of volume guarantee the new volume uses.Possible values: none, file, volume. This option controls whether the volume is guaranteed some amount of space in the aggregate. The default is volume, and file and none can be set by the administrator. Volume guaranteed means that the entire size of the volume is preallocated. The file value means that space is preallocated for all the space-reserved files and LUNs within the volume. Storage is not preallocated for files and LUNs that are not space-reserved. Writes to these can fail if the underlying aggregate has no space available to store the written data. This value can be set if fractional reserve is 100. The none value means that no space is preallocated, even if the volume contains space-reserved files or LUNs. If the aggregate is full, space is not available even for space-reserved files and LUNs within the volume. Setting this parameter to file or none enables you to provision more storage than is physically present in the aggregate (thin provisioning). When you use thin provisioning for a volume, it can run out of space even if it has not yet consumed its nominal size and you should carefully monitor space utilization to avoid unexpected errors due to the volume running out of space. For flexible root volumes, to ensure that system files, log files, and cores can be saved, the space-guarantee must be volume. This ensures technical support for the storage system, if a problem occurs. Disk space is preallocated when the volume is brought online and, if not used, returned to the aggregate when the volume is brought offline. It is possible to bring a volume online even when the aggregate has insufficient free space to preallocate to the volume. In this case, no space is preallocated, just as if the none option had been selected. In this situation, the vol options and vol status command display the actual value of the space-guarantee option, but indicate that it is disabled.

false

true (ByPropertyName)

SnapReserve

Optionally specifies the amount of space reserved on the volume for Snapshot copies. The default setting is 5 percent.

false

true (ByPropertyName)

FractionalReserve

This option changes the amount of space reserved for overwrites of reserved objects (LUNs, files) in a volume. This parameter is not supported on Infinite Volumes. The option is set to 100 by default with guarantee set to volume or file. A setting of 100 means that 100 percent of the required reserved space is actually reserved, so the objects are fully protected for overwrites. The value is set to 0 by default with guarantee set to none. The value can be either 0 or 100 when guarantee is set to volume or none. If guarantee is set to file, 100 is the only allowed value. Using a value of 0 indicates that no space will be reserved for overwrites. This returns the extra space to the available space for the volume, decreasing the total amount of space used. However, this does leave the protected objects in the volume vulnerable to out of space errors. If the percentage is set to 0%, the administrator must monitor the space usage on the volume and take corrective action.

false

true (ByPropertyName)

SpaceMgmtTryFirst

{volume_grow|snap_delete}] - Primary Space Management StrategyA flexible volume can be configured to automatically reclaim space in case the volume is about to run out of space, by either increasing the size of the volume using autogrow or deleting Snapshot copies in the volume using Snapshot autodelete. If this option is set to volume_grow the system will try to first increase the size of volume before deleting Snapshot copies to reclaim space. If the option is set to snap_delete the system first automatically deletes Snapshot copies and in case of failure to reclaim space tries to grow the volume. This parameter is not supported on Infinite Volumes.

false

true (ByPropertyName)

SpaceNearlyFullThresholdPercent

Optionally specifies the percentage at which the volume is considered nearly full, and above which an EMS warning is generated. The default value is 95%. Setting this threshold to 0 disables the volume nearly full space alerts. This parameter is not supported on Infinite Volumes.

false

true (ByPropertyName)

SpaceFullThresholdPercent

Optionally specifies the percentage at which the volume is considered full, and above which a critical EMS error is generated. The default value is 98%. Setting this threshold to 0 disables the volume full space alerts. This parameter is not supported on Infinite Volumes.

false

true (ByPropertyName)

Files

Optionally specifies the total number of files permitted on the volume. The default setting is 629. This value can be raised but cannot be lowered; the new value must be larger than the current value.

false

true (ByPropertyName)

FilesysSizeFixed

This option causes the file system to remain the same size and not grow or shrink when a SnapMirrored volume relationship is broken, or when a volume add is performed on it. It is automatically set to true when a volume becomes a SnapMirrored volume. It stays set to true after the SnapMirror break command is issued for the volume. This allows a volume to be SnapMirrored back to the source without needing to add disks to the source volume. If the volume is a traditional volume and the size is larger than the file system size, setting this option to false forces the file system to grow to the size of the volume. If the volume is a flexible volume and the volume size is larger than the file system size, setting this option to false forces the volume size to equal the file system size. The default setting is false.

false

true (ByPropertyName)

ExtentEnabled

Setting this option to on or space-optimized enables extents in the volume. This causes application writes to be written in the volume as a write of a larger group of related data blocks called an extent. Using extents may help workloads that perform many small random writes followed by large sequential reads. However, using extents may increase the amount of disk operations performed on the controller, so this option should only be used where this trade-off is desired. If the option is set to space-optimized then the reallocation update will not duplicate blocks from Snapshot copies into the active file system, and will result in conservative space utilization. Using space-optimized may be useful when the volume has Snapshot copies or is a SnapMirror source, when it can reduce the storage used in the volume and the amount of data that SnapMirror must move on the next update. The space-optimized value can result in degraded read performance of Snapshot copies. The default value is off; extents are not used.

false

true (ByPropertyName)

ReadRealloc

Setting this option to on or space-optimized enables read reallocation in the volume. This results in the optimization of file layout by writing some blocks to a new location on disk. The layout is updated only after the blocks have been read because of a user read operation, and only when updating their layout will provide better read performance in the future. Using read reallocation may help workloads that perform a mixture of random writes and large sequential reads. If the option is set to space-optimized then the reallocation update will not duplicate blocks from Snapshot copiesinto the active file system, and will result in conservative space utilization. Using space-optimized may be useful when the volume has Snapshot copies or is a SnapMirror source, when it can reduce the storage used in the volume and the amount of data that SnapMirror must move on the next update. The space-optimized value can result in degraded read performance of Snapshot copies. The default value is off.

false

true (ByPropertyName)

ExternalCache

Optionally specifies which WAFL external cache policy to apply to the volume. This parameter is not supported on Infinite Volumes. A WAFL external cache policy defines how the data blocks are cached for this volume. If an external cache policy is not assigned to this volume, the system uses the external cache policy that is assigned to the containing virtual storage server. If an external cache policy is not assigned to the containing virtual storage server, the system uses the default cluster-wide policy. The available WAFL external cache policies are: o Uncached - Caches nothing. o Metadata_Only - Caches indirect blocks and system metafiles. o Normal_Data - Caches indirect blocks, system metafiles, and randomly read user data. o Random_Write_Data - Caches normal data blocks and any blocks read as a result of random writes. o Readahead_Data - Caches normal data blocks and any sequentially read user data blocks. o Most_Data - Caches normal data blocks and any blocks read as a result of random writes or sequential reads. o Lopri_Data - Caches everything. o Default - Current cluster-wide default, which is Normal_Data.

false

true (ByPropertyName)

VmAlignSector

false

true (ByPropertyName)

VmAlignSuffix

false

true (ByPropertyName)

AutoSizeMode

{off|grow|grow_shrink}] - Autosize ModeSpecifies the autosize mode for the volume. The allowed values are grow, grow_shrink, and off. If this parameter is not specified, the existing autosize mode remains in effect. This parameter is not supported in Infinite Volumes. The various autosize modes are explained below: o off - The volume will not grow or shrink in size in response to the amount of used space. o grow - The volume will automatically grow when used space in the volume is above the grow threshold. o grow_shrink - The volume will grow or shrink in size in response to the amount of used space.

false

true (ByPropertyName)

MaxAutosize

Specifies the maximum size to which a flexible volume can grow. The default is 120% of the volume size at creation for a flexible volume, and the greater of the origin volume's size and the current value of max-autosize for a FlexCache volume if a size is not specified upon creation. This parameter is not supported in Infinite Volumes.

false

true (ByPropertyName)

AutosizeIncrement

The size of the volume is increased by the increment size specified by autosize-increment each time the volume is autogrown. A volume does not automatically grow if the current size of the volume is greater than or equal to the maximum size specified by the max-auto-size. The default is 5% of the volume size at the time autosize was enabled for the volume. This parameter is not supported in Infinite Volumes.

false

true (ByPropertyName)

AutosizeIncrementPercent

The increment percent specified with autosize-increment-percent is converted to a fixed increment size in bytes based on the volume size when volautosize -increment-percent is issued. The size of the volume is increased by the computed increment size each time the volume is autogrown. A volume will not automatically grow if the current size of the volume is greater than or equal to the maximum size specified with the max-autosize parameter. The default is 5% of volume size at the time autosize was enabled for the volume. This parameter is not supported in Infinite Volumes.

false

true (ByPropertyName)

MinAutosize

{<integer>[KB|MB|GB|TB|PB]}] - Minimum AutosizeSpecifies the minimum automatic size to whichthe volume shrinks. The default value is the volume size at the time when the grow_shrink autosize mode was enabled for the volume. If the volume was created with the grow_shrink autosize mode enabled, then the default minimum size will be equal to the initial volume size. This parameter is not supported in Infinite Volumes.

false

true (ByPropertyName)

AutosizeGrowThresholdPercent

Specifies the used space threshold for the automatic growth of the volume. When the volume used space becomes greater than this threshold, the volume will be grown unless it has reached the maximum autosize. This parameter is not supported in Infinite Volumes.

false

true (ByPropertyName)

AutosizeShrinkThresholdPercent

Specifies the used space threshold for the automatic shrink of the volume. When the volume used space becomes less than this threshold, the volume will be shrunk unless it has reached the minimum autosize. This parameter is not supported in Infinite Volumes.

false

true (ByPropertyName)

AutoDeleteEnabled

Specifies whether automatic deletion of Snapshot copies is enabled or disabled. If set to true, automatic deletion of Snapshot copies is enabled. If set to false automatic deletion of Snapshot copies is disabled.

false

true (ByPropertyName)

Commitment

Specifies which Snapshot copies can be automatically deleted to reclaim back space. When set to try, the Snapshot copies which are not locked by any application are deleted. When set to disrupt, the Snapshot copies which are not locked by Data Backing Functionalities (Volume Clones, LUN Clones, File Clones) are deleted. In disrupt mode, Snapshot locked by Data Protection Utilities like SnapMirror or Volume Move can be deleted. If such a locked Snapshot copy is deleted during the data transfer, the transfer is aborted. When set to destroy, Snapshot copies locked by even the Data Backing Functionalities are deleted.

false

true (ByPropertyName)

DeferDelete

{scheduled|user_created|prefix|none}] - Defer DeleteSpecifies which kind of Snapshot copies are deleted in the end. When set to scheduled, scheduled Snapshot copies are deleted in the end. When set to user_created, user Snapshot copies are deleted in the end. When set to prefix, Snapshot copies matching a certain prefix are deleted in the end. When set to none no defer deletion order is honored.

false

true (ByPropertyName)

Deleteorder

{newest_first|oldest_first}] - Delete Order. Specifies whether if the oldest Snapshot copy or the newest Snapshot copy is deleted first.

false

true (ByPropertyName)

DeferDeletePrefix

Specifies the prefix string for the -defer-delete prefix parameter.

false

true (ByPropertyName)

TargetFreeSpace

Specifies when you want automatic deletion of Snapshot copies to stop. Depending on the -trigger Snapshot copies are deleted till you reach the target free space percentage.

false

true (ByPropertyName)

Trigger

{volume|snap_reserve|space_reserve}] - TriggerSpecifies the condition which starts the automatic deletion of Snapshot copies. Setting this option to volume triggers automatic deletion of Snapshot copies when the volume reaches threshold capacity and the volume's space reserved for Snapshot copies has been exceeded. Setting the option to snap_reserve triggers automatic deletion of Snapshot copies when the space reserved for Snapshot copies reaches threshold capacity. Setting the option to space_reserve triggers automatic deletion of Snapshot copies when reserved space in the volume reaches threshold capacity and the volume's space reserved for Snapshot copies has been exceeded.

false

true (ByPropertyName)

DestroyList

Specifies a comma-separated list of data backing functions which are affected if automatic deletion of the Snapshot copy backing that service is triggered. Possible values for this option are: vol_clone, lun_clone, file_clone, sfsr, cifs_share, or none. With the exception of none, all options can be combined as a comma-separated list. If you specify vol_clone, the cloned volume backed by the Snapshot copy is deleted. If you specify lun_clone, and the LUN is in the process of being cloned when autodelete is triggered, the cloning operation is aborted. Any access to this LUN results in an error being reported to the client. If you specify file_clone, and the file cloning operation is in progress when autodelete is triggered, the cloning operation is aborted. Any access to this file results in an error being reported to the client. If you specify sfsr, and the file restore is in progress when autodelete is triggered, the restore operation is aborted. If the Snapshot copy is locked either by a lun_clone or file_clone or both, the -destroy-list must be set to lun_clone,file_clone. If the Snapshot copy is locked either by a lun_clone or sfsr operation or both, -destroy-list must be set to lun_clone, file_clone. The options file_clone and sfsr are equivalent to each other. If you set -destroy-list to lun_clone, file_clone and the Snapshot copy is backing a file clone or sfsr operation, both the operations are aborted. This is also the case when you set -destroy-list to lun_clone, sfsr.

false

true (ByPropertyName)

Session

false

true (ByPropertyName)

Host

Specifies the name or IP address of the host on which you execute the operation. The default is your local machine.

false

true (ByPropertyName)

Examples

Example 1: Provisioning a storage system volume using a template

 PS C:\> New-SdVolume -Name sqldbvolume -Aggregate sqldbaggregate -JunctionPath /sqldbvolume
-TemplateName C:\Program Files\SnapDrive\Templates\HyperVVHDxProvTemplate.xml -Size 128GB -StorageSystem sqlvirtualstorageserver

This example provisions a storage system volume using the specified template.

Name   : sqldbvolume
Vserver: sqlvirtualstorageserver
FullPath   : sqlvirtualstorageserver:/vol/sqldbvolume
JunctionPath   : /sqldbvolume
JunctionParentName :
SizeTotal  :
SizeUsed   :
SnapMirrorSource   :
SnapMirrorDest :
SnapVaultPrimary   :
SnapVaultSecondary :
FlexCloneEnabled   :
IsFlexClone:
Style  : ntfs
ResourceType   : SDStorageVolume
ResourceName   : sqlvirtualstorageserver:/vol/sqldbvolume
Ranges :