Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcVolAutosize


NAME
Set-NcVolAutosize

SYNOPSIS
Given the name of a flexible volume, set the autosize settings.

SYNTAX
Set-NcVolAutosize [-Name] <String> [-MinimumSize <String>] [-GrowThresholdPe
rcent <Int32>] [-ShrinkThresholdPercent <Int32>] [-VserverContext <String>]
[-Controller <NcController[]>] [[-MaximumSize] <String>] [[-IncrementSize] <
String>] [-Enabled] [<CommonParameters>]

Set-NcVolAutosize [-Name] <String> -Mode <String> [-MinimumSize <String>] [-
GrowThresholdPercent <Int32>] [-ShrinkThresholdPercent <Int32>] [-VserverCon
text <String>] [-Controller <NcController[]>] [[-MaximumSize] <String>] [[-I
ncrementSize] <String>] [<CommonParameters>]

Set-NcVolAutosize [-Name] <String> [-MinimumSize <String>] [-GrowThresholdPe
rcent <Int32>] [-ShrinkThresholdPercent <Int32>] [-VserverContext <String>]
[-Controller <NcController[]>] [[-MaximumSize] <String>] [[-IncrementSize] <
String>] [-Disabled] [<CommonParameters>]

Set-NcVolAutosize [-Name] <String> -Reset [-VserverContext <String>] [-Contr
oller <NcController[]>] [<CommonParameters>]

Set-NcVolAutosize [-Name] <String> [-VserverContext <String>] [-Controller <
NcController[]>] -AutosizeInfo <Autosize> [<CommonParameters>]


DESCRIPTION
Given the name of a flexible volume, set the autosize settings.


PARAMETERS
-Name <String>
The name of the flexible volume for which we want to set autosize.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-MinimumSize <String>
The flexible volume's minimum allowed size using the following format

<number>[k|m|g|t]

The amount is the absolute size to set. The optional trailing 'k', 'm',
'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes
', 'gigabytes', and 'terabytes' (respectively). If the trailing unit ch
aracter doesn't appear, then <number> is interpreted as the number of by
tes desired.

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

-GrowThresholdPercent <Int32>
The percentage of the flexible volume's capacity at which autogrow is in
itiated. The default grow threshold varies from 85% to 98%, depending on
the volume size. It is an error for the grow threshold to be less than
or equal to the shrink threshold.

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

-ShrinkThresholdPercent <Int32>
Specifies the percentage of the flexible volume's capacity at which auto
shrink is initiated. The default shrink threshold is 50%. It is an error
for the shrink threshold to be greater than or equal to the grow thresh
old.

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

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

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

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-MaximumSize <String>
Specify the flexible volume's maximum allowed size using the following f
ormat

<number>[k|m|g|t]

The amount is the absolute size to set. The optional trailing 'k', 'm',
'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes
', 'gigabytes', and 'terabytes' (respectively). If the trailing unit ch
aracter doesn't appear, then <number> is interpreted as the number of by
tes desired.

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-IncrementSize <String>
Specify the flexible volume's increment size using the following format

<number>[k|m|g|t]

The amount is the absolute size to set. The optional trailing 'k', 'm',
'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes
', 'gigabytes', and 'terabytes' (respectively). If the trailing unit ch
aracter doesn't appear, then <number> is interpreted as the number of by
tes desired.

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Enabled
Specify to enable the volume autosize feature.

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

-Mode <String>
Specify the flexible volume's autosize mode of operation. Valid values
are "grow", "grow_shrink", and "off". The default mode is "off".

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

-Disabled
Specify to disable the volume autosize feature.

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

-Reset
Set the value of Enabled, MaximumSize, IncrementSize, MinimumSize, GrowT
hresholdPercent, ShrinkThresholdPercent, and Mode to their default value
s.

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

-AutosizeInfo <Autosize>
This parameter accepts the output of Get-NcVolAutosize, as needed for pi
pelined invocations.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.C.Types.Volume.VolumeAttributes


NOTES


Category: volume
API: volume-autosize-set
Family: vserver

-------------- Example 1 --------------

C:\PS>Set-NcVolAutosize vol2 -Enabled -MaximumSize 200g -IncrementSize 1g |
Get-NcVolAutosize


Configure the autosize settings for volume 'vol2' and display the result.


Name IsEnabled IncrementSize MaximumSize
---- --------- ------------- -----------
vol2 True 1.0 GB 200.0 GB


-------------- Example 2 --------------

C:\PS>Get-NcVolAutosize vol1 | Set-NcVolAutosize vol2 | Get-NcVolAutosize


Get the autosize settings from volume 'vol1' and copy those to volume 'vol2'
and display the result.


Name IsEnabled IncrementSize MaximumSize
---- --------- ------------- -----------
vol2 True 100.0 MB 20.0 GB



RELATED LINKS
Get-NcVolAutosize







 Data ONTAP® PowerShell Toolkit