threshold-monitor

Configures the various threshold-monitor parameters.

Resource URIs


URI	Description
<base_URI>/config/running/threshold-monitor	Configure Threshold Monitoring parameters.


PUT URIs	Payload	Description
<base_URI>/config/running/threshold-monitor/hardware-resources	<hardware-resources> <count>{max-number-of-generated-events}</count> <interval>{time-interval-in-seconds}</interval> </hardware-resources>	Configures the global values for the count and interval. When configured, these constraints can be summed as: Generate a maximum of {max-number-of-generated-events} messages in {time-interval-in-seconds} units of time.
<base_URI>/config/running/threshold-monitor/bfd-session	<bfd-session> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </bfd-session>	Configures the monitoring of BFD Sessions.
<base_URI>/config/running/threshold-monitor/ecmp	<ecmp> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </ecmp>	Enables monitoring of ECMP Table resource utilization.
<base_URI>/config/running/threshold-monitor/host	<host> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </host>	Enables monitoring of Host Table resource utilization.
<base_URI>/config/running/threshold-monitor/lif	<lif> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </lif>	Enables monitoring of LIFs.
<base_URI>/config/running/threshold-monitor/mac-table	<mac-table> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </mac-table>	Enables monitoring of MAC Table resource utilizations.
<base_URI>/config/running/threshold-monitor/nexthop	<nexthop> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </nexthop>	Enables monitoring of Nexthop table entries and table's resource utilization.
<base_URI>/config/running/threshold-monitor/route	<route> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </route>	Enables monitoring of Route table entries and table's resource utilization.
<base_URI>/config/running/threshold-monitor/vxlan-tunnel	<vxlan-tunnel> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> </vxlan-tunnel>	Enables monitoring of the number of open VXLAN Tunnels.

Parameters

count max-number-of-generated-events

Configures the maximum number of events that are generated for the configured time interval. The range is 1-60 events. The default is 4 events.

interval interval-in-seconds

Specifies the time interval during which events are generated. The range is 30-900 seconds. The default value is 30 seconds.

high-limit high-limit-value

Configures the upper threshold limit of the monitored event that will trigger the configured action.

low-limit low-limit-value

Configures the lower threshold limit of the monitored event that will trigger the configured action.

action [ none | raslog | snmp | all ]

Specifies the action to be taken when a threshold is exceeded. The values supported are all, none, raslog, and snmp. Default is all.

all: RASLOG and SNMP trap will be sent when the threshold is exceeded.
none: No action will be taken when the threshold is exceeded.
raslog: Only RASLOG will be sent when the threshold is exceeded.
snmp: SNMP traps will be sent when the threshold is exceeded.

Usage Guidelines

PUT and PATCH operations are supported.

Examples

Example

The following example uses the PUT option to retrieve the configuration details.

URI

http://host:80/rest/config/running/threshold-monitor

curl -v -X PATCH -d 
"<mac-table><high-limit>95</high-limit><low-limit>80</low-limit><actions>raslog</actions>
<count>2</count><interval>60</interval></mac-table>"

curl -v -X PATCH -d 
"<bfd-session><high-limit>85</high-limit><low-limit>60</low-limit><actions>snmp</actions>
<count>2</count><interval>60</interval></bfd-session>"

curl -v -X PATCH -d 
"<vxlan-tunnel><high-limit>95</high-limit><low-limit>90</low-limit><actions>all</actions>
<count>2</count><interval>60</interval></vxlan-tunnel>"

curl -v -X PATCH -d 
"<lif><high-limit>65</high-limit><low-limit>50</low-limit><actions>all</actions>
<count>2</count><interval>60</interval></lif>"

 curl -v -X PATCH -d
"<hardware-resources><count>90</count><interval>60</interval></hardware-resources>"