Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcEmsRoute


NAME
Get-NcEmsRoute

SYNOPSIS
Get information on EMS routes.

SYNTAX
Get-NcEmsRoute [[-Name] <String[]>] [[-Severity] <String[]>] [-Attributes <E
msRoutingInfo>] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcEmsRoute -Template [-Controller <NcController[]>] [<CommonParameters>]

Get-NcEmsRoute -Query <EmsRoutingInfo> [-Attributes <EmsRoutingInfo>] [-Cont
roller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get information on EMS routes.


PARAMETERS
-Name <String[]>
The name of the EMS message. Data ONTAP wildcards are permitted.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Severity <String[]>
The event severity. Data ONTAP wildcards are permitted. Possible value
s:
"emergency" - System is unusable
"alert" - Action must be taken immediately
"critical" - Critical condition
"error" - Error condition
"warning" - Warning condition
"notice" - Normal but significant condition
"informational" - Information message
"debug" - A debugging message

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Attributes <EmsRoutingInfo>
For improved scalability in large clusters, provide an EmsRoutingInfo ob
ject with various fields set to indicate which fields to return on all o
bjects. Undesired fields should remain set to null. Use "Get-NcEmsRout
e -Template" to get the initially empty EmsRoutingInfo object. If not s
pecified, all data is returned for each object.

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

-Template
Specify to get an empty EmsRoutingInfo object for use with advanced quer
ies involving the Query attribute.

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

-Query <EmsRoutingInfo>
For advanced queries, provide a EmsRoutingInfo object with various field
s set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcEmsRoute -Template" to get the initially empty
EmsRoutingInfo object.

Required? true
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
NetApp.Ontapi.Filer.C.Ems810.EmsRoutingInfo


NOTES


Category: ems
API: ems-routing-get-iter
Family: cluster

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

C:\PS>Get-NcEmsRoute -Name app.log.* -Severity warning


Get all of the EMS route information for the requested messages.


Action : (UNKNOWN)
Description : This event is issued when an application is in
a condition which is not an error, but whi
ch may require special handling.
Destinations :
FrequencyThreshold : 0
MessageName : app.log.warn
Severity : warning
SnmpSupport : True
TimeThreshold : 0
FrequencyThresholdSpecified : True
SnmpSupportSpecified : True
TimeThresholdSpecified : True


-------------- Example 2 --------------

C:\PS>$q = Get-NcEmsRoute -Template
$q.SnmpSupport = $true
Get-NcEmsRoute -Query $q


Get all of the EMS message routes for messages that have SNMP support.


NcController : 10.61.172.155
Action : (UNKNOWN)
Description : This event is issued when an application is in
a condition that should be corrected immed
iately.
Destinations :
FrequencyThreshold : 0
MessageName : app.log.alert
Severity : alert
SnmpSupport : True
TimeThreshold : 0
FrequencyThresholdSpecified : True
SnmpSupportSpecified : True
TimeThresholdSpecified : True

NcController : 10.61.172.155
Action : (UNKNOWN)
Description : This event is issued when an application encou
nters a critical condition.
Destinations :
FrequencyThreshold : 0
MessageName : app.log.crit
Severity : critical
SnmpSupport : True
TimeThreshold : 0
FrequencyThresholdSpecified : True
SnmpSupportSpecified : True
TimeThresholdSpecified : True

NcController : 10.61.172.155
Action : (UNKNOWN)
Description : This event is issued when an application is re
quired to be debugged.
Destinations :
FrequencyThreshold : 0
MessageName : app.log.debug
Severity : debug
SnmpSupport : True
TimeThreshold : 0
FrequencyThresholdSpecified : True
SnmpSupportSpecified : True
TimeThresholdSpecified : True



RELATED LINKS
Add-NcEmsRouteDestination
Remove-NcEmsRouteDestination
Set-NcEmsRoute







 Data ONTAP® PowerShell Toolkit