Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Update-NcVserver


NAME
Update-NcVserver

SYNOPSIS
Modify the attributes of vserver or a group of vserver objects.

SYNTAX
Update-NcVserver -Query <VserverInfo> -Attributes <VserverInfo> [-ContinueOn
Failure] [-MaxFailureCount <Int32>] [-Controller <NcController[]>] [-WhatIf]
[-Confirm] [<CommonParameters>]


DESCRIPTION
Modify the attributes of vserver or a group of vserver objects.


PARAMETERS
-Query <VserverInfo>
A VserverInfo object with various fields set to indicate which vservers
to modify. Other fields should remain set to null. Use "Get-NcVserver
-Template" to get the initially empty VserverInfo object.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Attributes <VserverInfo>
A VserverInfo 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-NcVserver -Template" to get th
e initially empty VserverInfo 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
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

-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: vserver
API: vserver-modify-iter
Family: cluster

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

C:\PS>$q = Get-NcVserver -Template
$q.Vserver = "vserver*"
$a = Get-NcVserver -Template
$a.Comment = "SQL Server LUNs"
Update-NcVserver -Query $q -Attributes $a


Update the comment field on all vservers whose name matches the specified pa
ttern.


NcController : 10.61.172.155
SuccessCount : 3
FailureCount : 0
SuccessList : {vserver1, vserver2, vserver3}
FailureList : {}



RELATED LINKS
Get-NcVserver







 Data ONTAP® PowerShell Toolkit