|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Update-NcOption
NAME
Update-NcOption
SYNOPSIS
Modify the attributes of options or a group of options objects.
SYNTAX
Update-NcOption -Query <OptionInfo> -Attributes <OptionInfo> [-ContinueOnFai
lure] [-MaxFailureCount <Int32>] [-VserverContext <String>] [-Controller <Nc
Controller[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Modify the attributes of options or a group of options objects.
PARAMETERS
-Query <OptionInfo>
An OptionInfo object with various fields set to indicate which options t
o modify. Other fields should remain set to null. Use "Get-NcOption -T
emplate" to get the initially empty OptionInfo object.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Attributes <OptionInfo>
An OptionInfo object with various fields set to the values that will be
set on all objects that are identified by the Query parameter. Other fi
elds should remain set to null. Use "Get-NcOption -Template" to get the
initially empty OptionInfo object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ContinueOnFailure
This input element is useful when multiple objects match a given query.
If set to true, the API will continue modifying the next matching objec
t even when modification of a previous object fails. If set to false, t
he API will return on the first failure. Default: false.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-MaxFailureCount <Int32>
When allowing failures, then this input element may be provided to limit
the number of failed modify operations before the server gives up and r
eturns. If set, the cmdlet will continue modifying the next matching ob
ject even when the modification of a previous matching object fails, and
do so until the total number of objects failed to be modified reaches t
he maximum specified. If set to the maximum or not provided, then there
will be no limit on the number of failed modify operations. Only appli
cable if ContinueOnFailure is specified. Default: 2^32-1
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 Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
<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.PowerShell.SDK.Cmdlets.TableModifyResult
NOTES
Category: options
API: options-modify-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>$a = Get-NcOption -Template
$a.Value = "on"
$q = Get-NcOption -Template
$q.Name = "backup.log.enable"
$q.Vserver = "Cerebus-*"
Update-NcOption -Query $q -Attributes $a
Set option 'backup.log.enable' to 'on' on all vservers matching "Cerebus-*".
NcController : cerebus
SuccessCount : 4
FailureCount : 0
SuccessList : {backup.log.enable, backup.log.enable, backup.log.enable, bac
kup.log.enable}
FailureList : {}
RELATED LINKS
Get-NcOption
Set-NcOption
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|