Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Update-NcEmsDestination


NAME
Update-NcEmsDestination

SYNOPSIS
Modify several EMS destinations.

SYNTAX
Update-NcEmsDestination -Query <EmsDestinationInfo> -Attributes <EmsDestinat
ionInfo> [-ContinueOnFailure] [-MaxFailureCount <Int32>] [-Controller <NcCon
troller[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Modify several EMS destinations. This cmdlet uses the query mechanism to up
date multiple records at once.


PARAMETERS
-Query <EmsDestinationInfo>
A EmsDestinationInfo object with various fields set to indicate which po
licies to modify. Other fields should remain set to null. Use "Get-NcE
msDestination -Template" to get the initially empty EmsDestinationInfo o
bject.

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

-Attributes <EmsDestinationInfo>
A EmsDestinationInfo object with various fields set to the values that w
ill be set on all objects that are identified by the Query parameter. O
ther fields should remain set to null. Use "Get-NcEmsDestination -Templ
ate" to get the initially empty EmsDestinationInfo 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: ems
API: ems-destination-modify-iter
Family: cluster

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

C:\PS>$q = Get-NcEmsDestination -Template
$q.Name = "test*"
$a = Get-NcEmsDestination -Template
$a.Mail = "admin@localhost"
Update-NcEmsDestination -Query $q -Attributes $a


Update all of the "test" EMS destinations to have a mail address of "admin@l
ocalhost" for the current cluster.


SuccessCount : 2
FailureCount : 0
SuccessList : {NetApp.Ontapi.Filer.C.Ems810.EmsDestinationInfo, NetApp.Onta
pi.Filer.C.Ems810.EmsDestinationInfo}
FailureList : {}



RELATED LINKS
Get-NcEmsDestination
New-NcEmsDestination
Remove-NcEmsDestination
Set-NcEmsDestination







 Data ONTAP® PowerShell Toolkit