Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcDashboardAlarmThreshold


NAME
Get-NcDashboardAlarmThreshold

SYNOPSIS
Get alarm threshold settings for all metric groups.

SYNTAX
Get-NcDashboardAlarmThreshold [[-DashboardMetricType] <String[]>] [-Attribut
es <DashboardAlarmThresholdInfo>] [-Controller <NcController[]>] [<CommonPar
ameters>]

Get-NcDashboardAlarmThreshold -Template [-Controller <NcController[]>] [<Com
monParameters>]

Get-NcDashboardAlarmThreshold -Query <DashboardAlarmThresholdInfo> [-Attribu
tes <DashboardAlarmThresholdInfo>] [-Controller <NcController[]>] [<CommonPa
rameters>]


DESCRIPTION
Get alarm threshold settings for all metric groups.


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

-Attributes <DashboardAlarmThresholdInfo>
For improved scalability in large clusters, provide a DashboardAlarmThre
sholdInfo object with various fields set to indicate which fields to ret
urn on all objects. Undesired fields should remain set to null. Use "G
et-NcDashboardAlarmThreshold -Template" to get the initially empty Dashb
oardAlarmThresholdInfo object. If not specified, all data is returned f
or 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 DashboardAlarmThresholdInfo 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 <DashboardAlarmThresholdInfo>
For advanced queries, provide a DashboardAlarmThresholdInfo object with
various fields set to indicate which records to retrieve. Other fields
should remain set to null. Use "Get-NcDashboardAlarmThreshold -Template
" to get the initially empty DashboardAlarmThresholdInfo 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.DashboardAlarmThresholdInfo


NOTES


Category: dashboard
API: dashboard-alarm-threshold-get-iter
Family: cluster

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

C:\PS>Get-NcDashboardAlarmThreshold


Get all of the dashboard alarm thresholds.


DashboardMetricType PollingIntervalTS WarningThreshold CriticalTh
reshold IsUserNotificationEnabled
------------------- ----------------- ---------------- ----------
------- -------------------------
aggregate_used 00:05:00 85%
95% True
cpu_busy 00:05:00 100%
False
op_latency 00:05:00 100ms
500ms False
port_problems 00:05:00 1%
5% False
port_util 00:05:00 100%
False


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

C:\PS>$q = Get-NcDashboardAlarmThreshold -Template
$q.IsUserNotificationEnabled = $true
Get-NcDashboardAlarmThreshold -Query $q


Get all of the dashboard alarm thresholds with the user notification enabled
.


DashboardMetricType PollingIntervalTS WarningThreshold CriticalTh
reshold IsUserNotificationEnabled
------------------- ----------------- ---------------- ----------
------- -------------------------
aggregate_used 00:05:00 85%
95% True



RELATED LINKS
Set-NcDashboardAlarmThreshold







 Data ONTAP® PowerShell Toolkit