Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Set-NaAggrOption


NAME
Set-NaAggrOption

SYNOPSIS
Set the specified option for the given aggregate.

SYNTAX
Set-NaAggrOption [-Name] <String> [-Key] <String> [-Value] <String> [-Contro
ller <NaController>] [<CommonParameters>]

Set-NaAggrOption [-Name] <String> [-Options] <AggrOptionInfo[]> [-Controller
<NaController>] [<CommonParameters>]


DESCRIPTION
Set the specified option for the given aggregate to "Value". The change rem
ains effective even if the filer is rebooted. Some options have values tha
t are numbers, and some have values that are "on" (also expressible as "yes"
, "true", or "1" ) or "off" (also expressible as "no", "false", or "0"). A m
ixture of uppercase and lowercase characters may be used when typing an opti
on's value. Note that the "root" option is special in that it doesn't have
a corresponding value.


PARAMETERS
-Name <String>
Name of the aggregate 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>
Option name.

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

-Value <String>
NULL/empty value only in the case of the "root" option.

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

-Options <AggrOptionInfo[]>
An array of AggrOptionInfo values. Note that not all options returned b
y Get-NaAggrOption 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.Aggr.AggrInfo


NOTES


Category: aggr
API: aggr-set-option

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

C:\PS>Set-NaAggrOption aggr1 snapshot_autodelete off


Turn off snapshot autodelete for aggregate 'aggr1'.





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

C:\PS>get-naaggr | Set-NaAggrOption -Key lost_write_protect -Value on


Enable lost-write protection on all aggregates.






RELATED LINKS
Get-NaAggrOption







 Data ONTAP® PowerShell Toolkit