Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcAggrOption


NAME
Set-NcAggrOption

SYNOPSIS
Set the specified option for the given aggregate.

SYNTAX
Set-NcAggrOption [-Name] <String> [-Key] <String> [-Value] <String> [-Contro
ller <NcController[]>] [<CommonParameters>]

Set-NcAggrOption [-Name] <String> [-Options] <AggrOptionInfo[]> [-Controller
<NcController[]>] [<CommonParameters>]


DESCRIPTION
Set the specified option for the given aggregate. The change remains effect
ive even if the controller is rebooted. Some options have values that are
numbers, and some have values that are "on" (also expressible as "yes", "tru
e", or "1" ) or "off" (also expressible as "no", "false", or "0"). A mixtur
e of uppercase and lowercase characters may be used when typing an option's
value. Note that the "root" option is special in that it doesn't have a cor
responding value. This API does not support modifying options of striped agg
regates.


PARAMETERS
-Name <String>
Name of the aggregate whose option is to be set.

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>
The value to set the named option. It may be the 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 <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

-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.C.Types.Aggr.AggrAttributes


NOTES


Category: aggr
API: aggr-set-option
Family: cluster

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

C:\PS>Set-NcAggrOption aggr3 raid_lost_write off


Set an option value for aggregate 'aggr3'.


Name State TotalSize Used Available Disks RaidType RaidSize Volumes
---- ----- --------- ---- --------- ----- -------- -------- -------
aggr3 online 717.1 GB 0% 717.1 GB 8 raid_dp,normal 16 0



RELATED LINKS
Get-NcAggrOption







 Data ONTAP® PowerShell Toolkit