|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcDashboardAlarm
NAME
Get-NcDashboardAlarm
SYNOPSIS
Get alarm monitoring data for all objects in the cluster.
SYNTAX
Get-NcDashboardAlarm [[-DashboardMetricType] <String[]>] [[-Node] <String[]>
] [[-ObjectName] <String[]>] [-Attributes <DashboardAlarmInfo>] [-Controller
<NcController[]>] [<CommonParameters>]
Get-NcDashboardAlarm -Template [-Controller <NcController[]>] [<CommonParame
ters>]
Get-NcDashboardAlarm -Query <DashboardAlarmInfo> [-Attributes <DashboardAlar
mInfo>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Get alarm monitoring data for all objects in the cluster.
PARAMETERS
-DashboardMetricType <String[]>
The type of metric being monitored. Possible values:
"cpu_busy" - CPU Utilization
"port_util" - Port Utilization
"op_latency" - Average Client Latency of NFS and CIFS operations
"aggregate_used" - Storage Aggregate Utilization
"port_problems" - Packet Error Ratio
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Node <String[]>
Name of the node associated with the alarm metrics.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ObjectName <String[]>
Name associated with the object being monitored. For example, the Objec
tName is the name of the node if the DashboardMetricType is cpu-busy.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <DashboardAlarmInfo>
For improved scalability in large clusters, provide a DashboardAlarmInfo
object with various fields set to indicate which fields to return on al
l objects. Undesired fields should remain set to null. Use "Get-NcDash
boardAlarm -Template" to get the initially empty DashboardAlarmInfo obje
ct. 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 DashboardAlarmInfo 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 <DashboardAlarmInfo>
For advanced queries, provide a DashboardAlarmInfo object with various f
ields set to indicate which records to retrieve. Other fields should re
main set to null. Use "Get-NcDashboardAlarm -Template" to get the initi
ally empty DashboardAlarmInfo 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.Dashboard.DashboardAlarmInfo
NOTES
Category: dashboard
API: dashboard-alarm-get-iter
Family: cluster
-------------- Example 1 --------------
C:\PS>Get-NcDashboardAlarm -DashboardMetricType aggregate_used
Get all of the aggregate_used dashboard alarms.
DashboardMetricType ObjectName State LastVa
lue HighValue Node
------------------- ---------- ----- ------
--- --------- ----
aggregate_used aggr0_fas3070cluster01_02_0 critical
95% 95% fas3070cluster01-01
aggregate_used aggr0 critical
95% 95% fas3070cluster01-01
-------------- Example 2 --------------
C:\PS>$q = Get-NcDashboardAlarm -Template
$q.HighValue = ">90%"
Get-NcDashboardAlarm -Query $q
Get all the dashboard alarms with a high value greater than 90%.
DashboardMetricType ObjectName State LastVa
lue HighValue Node
------------------- ---------- ----- ------
--- --------- ----
aggregate_used aggr0_fas3070cluster01_02_0 critical
95% 95% fas3070cluster01-01
aggregate_used aggr0 critical
95% 95% fas3070cluster01-01
RELATED LINKS
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|