Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Update-NcEmsRoute


NAME
Update-NcEmsRoute

SYNOPSIS
Modify several EMS routes.

SYNTAX
Update-NcEmsRoute -Query <EmsRoutingInfo> -Attributes <EmsRoutingInfo> [-Con
tinueOnFailure] [-MaxFailureCount <Int32>] [-Controller <NcController[]>] [-
WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Modify several EMS routes. This cmdlet uses the query mechanism to update m
ultiple records at once.


PARAMETERS
-Query <EmsRoutingInfo>
A EmsRoutingInfo object with various fields set to indicate which polici
es to modify. Other fields should remain set to null. Use "Get-NcEmsRo
ute -Template" to get the initially empty EmsRoutingInfo object.

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

-Attributes <EmsRoutingInfo>
A EmsRoutingInfo object with various fields set to the values that will
be set on all objects that are identified by the Query parameter. Other
fields should remain set to null. Use "Get-NcEmsRoute -Template" to ge
t the initially empty EmsRoutingInfo 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-routing-modify-iter
Family: cluster

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

C:\PS>$q = Get-NcEmsRoute -Template
$q.MessageName = "app.log.*"
$a = Get-NcEmsRoute -Template
$a.Destinations = @("asup")
Update-NcEmsRoute -Query $q -Attributes $a


Set the destination to "asup" for all of the app.log.* EMS messages.


SuccessCount : 8
FailureCount : 0
SuccessList : {NetApp.Ontapi.Filer.C.Ems810.EmsRoutingInfo, NetApp.Ontapi.F
iler.C.Ems810.EmsRoutingInfo, NetApp.Ontapi
.Filer.C.Ems810.EmsRoutingInfo, NetApp.Ontapi.Filer.C.Ems810.
EmsRoutingInfo...}
FailureList : {}



RELATED LINKS
Get-NcEmsRoute
Set-NcEmsRoute







 Data ONTAP® PowerShell Toolkit