|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Update-NcVol
NAME
Update-NcVol
SYNOPSIS
Modify the attributes of volume or a group of volume objects.
SYNTAX
Update-NcVol -Query <VolumeAttributes> -Attributes <VolumeAttributes> [-Cont
inueOnFailure] [-MaxFailureCount <Int32>] [-VserverContext <String>] [-Infin
iteVolume] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Modify the attributes of volume or a group of volume objects.
When run with the InfiniteVolume switch, the cmdlet runs asynchronously. Th
e status of the job can be tracked using the Job cmdlets.
PARAMETERS
-Query <VolumeAttributes>
A VolumeAttributes object with various fields set to indicate which volu
mes to modify. Other fields should remain set to null. Use "Get-NcVol
-Template" to get the initially empty VolumeAttributes object.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Attributes <VolumeAttributes>
A VolumeAttributes object with various fields set to the values that wil
l be set on all objects that are identified by the Query parameter. Oth
er fields should remain set to null. Use "Get-NcVol -Template" to get t
he initially empty VolumeAttributes 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
-InfiniteVolume
Specify the InfiniteVolume parameter to indicate the volume is an Infini
te Volume. If a VolumeAttributes object is piped to this cmdlet, the In
finiteVolume switch will be automatically set.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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
<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: volume
API: volume-modify-iter, volume-modify-iter-async
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>$q = Get-NcVol -Template
Initialize-NcObjectProperty $q VolumeIdAttributes
$q.VolumeIdAttributes.Name = "vol1|vol2"
$q.VolumeIdAttributes.OwningVserverName = "vserver1"
$a = Get-NcVol -Template
Initialize-NcObjectProperty $a VolumeIdAttributes
$a.VolumeIdAttributes.Comment = "Database volumes"
Update-NcVol -Query $q -Attributes $a
Using this cmdlet and others, execute an advanced query to set the comment f
ield on multiple volumes.
NcController : 10.61.172.155
SuccessCount : 2
FailureCount : 0
SuccessList : {vol1, vol2}
FailureList : {}
RELATED LINKS
Get-NcVol
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|