Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Set-NaVolOption


NAME
Set-NaVolOption

SYNOPSIS
Set the option named 'Key' to the value specified by 'Value' in the specifie
d volume.

SYNTAX
Set-NaVolOption [-Name] <String> [-Key] <String> [-Value] <String> [-Control
ler <NaController>] [-WhatIf] [-Confirm] [<CommonParameters>]

Set-NaVolOption [-Name] <String> [-Options] <VolumeOptionInfo[]> [-Controlle
r <NaController>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Set the option named 'Key' to the value specified by 'Value' in the specifie
d volume. The change remains effective even after the filer is rebooted. So
me options have values that are numbers or strings, and others have values t
hat are 'on' (also expressible as 'yes', 'true', or '1' ) or "off" (also exp
ressible as 'no', 'false', or '0'). A mixture of uppercase and lowercase ch
aracters may be used for an option's value. Note that the 'root' option is
special in that it does not have an associated value. Also, note that some o
f these options can NOT be set for a flexible volume, as they relate only to
aggregates (either free-standing ones or those embedded in traditional volu
mes). Other options may only apply for flexible volumes.


PARAMETERS
-Name <String>
Name of the volume for which we want to set an option.

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

-Key <String>
Name of the option to be set.

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

-Value <String>
The value to set the named option (except for option 'root', which has n
o associated value).

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

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

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

-WhatIf


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

-Confirm


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

-Options <VolumeOptionInfo[]>
An array of VolumeOptionInfo values. Note that not all options returned
by Get-NaVolOption may be set.

Required? true
Position? 2
Default value
Accept pipeline input? false
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.Types.Volume.VolumeInfo


NOTES


Category: volume
API: volume-set-option

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

C:\PS>Set-NaVolOption vol2 compression on


Enable compression for volume 'vol2' (which requires a license).


Set-NaVolOption : Operation requires a compression license

DedupeEnabled : True
ChecksumStyle : block
CloneChildren : {vol2clone}
CloneParent :
ContainingAggregate : aggr1
DiskCount : 8
FilesTotal : 6381567
FilesUsed : 208
IsChecksumEnabled : True
IsInconsistent : False
IsSnaplock : False
IsUnrecoverable : False
MirrorStatus : unmirrored
Name : vol2
PercentageUsed : 50
PlexCount : 1
Plexes : {/aggr1/plex0}
QuotaInit : 0
RaidSize : 16
RaidStatus : raid_dp,sis
Reserve : 0
ReserveRequired : 0
ReserveUsed : 0
Sis : idle
SizeAvailable : 95894605824
SizeTotal : 193273528320
SizeUsed : 97378922496
SnaplockType :
SpaceReserve : volume
SpaceReserveEnabled : True
State : online
Type : flex
Uuid : e91dc1f8-ab4f-11dd-867f-00a09806c227
IsUnrecoverableSpecified : True
PercentageUsedSpecified : True
SpaceReserveEnabledSpecified : True



RELATED LINKS
Get-NaVolOption







 Data ONTAP® PowerShell Toolkit