Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcDashboardAlarmThreshold


NAME
Set-NcDashboardAlarmThreshold

SYNOPSIS
Modify alarm threshold settings for the given metric group.

SYNTAX
Set-NcDashboardAlarmThreshold [-DashboardMetricType] <String> [-PollingInter
val <Int32>] [-IsUserNotificationEnabled [<Boolean>]] [-Controller <NcContro
ller[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Set-NcDashboardAlarmThreshold [-DashboardMetricType] <String> [-WarningThres
hold <Int64>] [-CriticalThreshold <Int64>] -ThresholdUnits <String> [-Pollin
gInterval <Int32>] [-IsUserNotificationEnabled [<Boolean>]] [-Controller <Nc
Controller[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Modify alarm threshold settings for the given metric group.


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? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-PollingInterval <Int32>
The refresh interval for the alarm dashboard metrics (in seconds).

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

-IsUserNotificationEnabled [<Boolean>]
Specifies whether user notifications are enabled.

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

-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

-WarningThreshold <Int64>
The threshold value that must be reached to generate a warning alarm for
this type of metric.

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

-CriticalThreshold <Int64>
The threshold value that must be reached to generate a critical alarm fo
r this type of metric.

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

-ThresholdUnits <String>
Threshold Units Possible values:
"none" - none
"ms" - milliseconds
"percent" - percent

Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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-modify
Family: cluster

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

C:\PS>Set-NcDashboardAlarmThreshold -DashboardMetricType port_problems -Warn
ingThreshold 2 -ThresholdUnits percent


Set the warning threshold for the dashboard metric type port_problems to 2%.


DashboardMetricType PollingIntervalTS WarningThreshold CriticalTh
reshold IsUserNotificationEnabled
------------------- ----------------- ---------------- ----------
------- -------------------------
port_problems 00:05:00 2%
5% False



RELATED LINKS
Get-NcDashboardAlarmThreshold







 Data ONTAP® PowerShell Toolkit