Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcEmsDestination


NAME
Get-NcEmsDestination

SYNOPSIS
Get information on EMS destinations.

SYNTAX
Get-NcEmsDestination [[-Name] <String[]>] [[-Mail] <String[]>] [[-Snmp] <Str
ing[]>] [-Attributes <EmsDestinationInfo>] [-Controller <NcController[]>] [<
CommonParameters>]

Get-NcEmsDestination -Template [-Controller <NcController[]>] [<CommonParame
ters>]

Get-NcEmsDestination -Query <EmsDestinationInfo> [-Attributes <EmsDestinatio
nInfo>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get information on EMS destinations.


PARAMETERS
-Name <String[]>
The name of the EMS destination.

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

-Mail <String[]>
The e-mail address to which events are sent.

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

-Snmp <String[]>
The SNMP addresses to which traps are sent.

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

-Attributes <EmsDestinationInfo>
For improved scalability in large clusters, provide an EmsDestinationInf
o object with various fields set to indicate which fields to return on a
ll objects. Undesired fields should remain set to null. Use "Get-NcEms
Destination -Template" to get the initially empty EmsDestinationInfo obj
ect. If not specified, all data is returned for each object.

Required? false
Position? named
Default value
Accept pipeline input? false
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

-Template
Specify to get an empty EmsDestinationInfo object for use with advanced
queries involving the Query attribute.

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

-Query <EmsDestinationInfo>
For advanced queries, provide a EmsDestinationInfo object with various f
ields set to indicate which records to retrieve. Other fields should re
main set to null. Use "Get-NcEmsDestination -Template" to get the initi
ally empty EmsDestinationInfo 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
DataONTAP.C.Types.Ems.EmsDestinationInfo


NOTES


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

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

C:\PS>Get-NcEmsDestination asup


Get the EMS destination named asup.


HideParameters : False
Mail :
Name : asup
Snmp :
SnmpCommunity :
Syslog :
SyslogFacility :



RELATED LINKS
Set-NcEmsDestination
Remove-NcEmsDestination
Update-NcEmsDestination
New-NcEmsDestination







 Data ONTAP® PowerShell Toolkit