threshold-monitor

Configures the various threshold-monitor parameters.

Resource URIs


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


GET URIs	Description
<base-uri>/config/running/threshold-monitor/hardware-resources	Retrieves the global values for count and interval. These constraints can be summarized as Generate a maximum of {count} messages in {interval} units of time.
<base-uri>/config/running/threshold-monitor/bfd-sessions	Retrieves the configuration for monitoring BFD sessions.
<base-uri>/config/running/threshold-monitor/ecmp	Retrieves the configuration for monitoring ECMP Table resource utilization.
<base-uri>/config/running/threshold-monitor/host	Retrieves the configuration for monitoring Host Table resource utilization.
<base-uri>/config/running/threshold-monitor/lif	Retrieves the configuration for monitoring LIFs
<base-uri>/config/running/threshold-monitor/mac-table	Retrieves the configuration for monitoring MAC Table resource utilization.
<base-uri>/config/running/threshold-monitor/nexthop	Retrieves the configuration for monitoring Nexthop Table resource utilization.
<base-uri>/config/running/threshold-monitor/route	Retrieves the configuration for monitoring Route Table resource utilization.
<base-uri>/config/running/threshold-monitor/vxlan-tunnel	Retrieves the configuration for monitoring the number of open VXLAN Tunnels.
<base-uri>/config/running/threshold-monitor/acl	Retrieves the configuration for monitoring the various ACL resource usage.
<base-uri>/config/running/threshold-monitor/acl/ip-in	Retrieves the configuration for monitoring the number of available filters for IPv4 Ingress ACLs.
<base-uri>/config/running/threshold-monitor/acl/ip-out	Retrieves the configuration for monitoring the number of available filters for IPv4 Egress ACLs.
<base-uri>/config/running/threshold-monitor/acl/ipv6-in	Retrieves the configuration for monitoring the number of available filters for IPv6 Ingress ACLs.
<base-uri>/config/running/threshold-monitor/acl/ipv6-out	Retrieves the configuration for monitoring the number of available filters for IPv6 Egress ACLs.
<base-uri>/config/running/threshold-monitor/acl/mac-in	Retrieves the configuration for monitoring the number of available filters for MAC Ingress ACLs.
<base-uri>/config/running/threshold-monitor/acl/mac-out	Retrieves the configuration for monitoring the number of available filters for MAC Egress ACLs.


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 summarized 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.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ip-in> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ip-in> </acl>	Enables monitoring of the available filters when configuring IP Ingress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ip-out> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ip-out> </acl>	Enables monitoring of the available filters when configuring IP Egress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ipv6-in> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ipv6-in> </acl>	Enables monitoring of the available filters when configuring IPv6 Ingress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ipv6-out> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ipv6-out> </acl>	Enables monitoring of the available filters when configuring IPv6 Egress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <mac-in> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <mac-in> </acl>	Enables monitoring of the available filters when configuring MAC Ingress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <mac-out> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <mac-out> </acl>	Enables monitoring of the available filters when configuring MAC Egress ACLs.


PATCH 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 summarized 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.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ip-in> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ip-in> </acl>	Enables monitoring of the available filters when configuring IP Ingress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ip-out> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ip-out> </acl>	Enables monitoring of the available filters when configuring IP Egress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ipv6-in> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ipv6-in> </acl>	Enables monitoring of the available filters when configuring IPv6 Ingress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <ipv6-out> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <ipv6-out> </acl>	Enables monitoring of the available filters when configuring IPv6 Egress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <mac-in> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <mac-in> </acl>	Enables monitoring of the available filters when configuring MAC Ingress ACLs.
<base-uri>/config/running/threshold-monitor/alc	<acl> <mac-out> <high-limit>{high-limit-value}</high-limit> <low-limit>{low-limit-value}</low-limit> <actions>{action}</actions> <mac-out> </acl>	Enables monitoring of the available filters when configuring MAC Egress ACLs.


Delete URIs
<base-uri>/config/running/threshold-monitor/hardware-resources
<base-uri>/config/running/threshold-monitor/hardware-resources/count
<base-uri>/config/running/threshold-monitor/hardware-resources/interval
<base-uri>/config/running/threshold-monitor/bfd-sessions
<base-uri>/config/running/threshold-monitor/ecmp
<base-uri>/config/running/threshold-monitor/host
<base-uri>/config/running/threshold-monitor/lif
<base-uri>/config/running/threshold-monitor/mac-table
<base-uri>/config/running/threshold-monitor/mac-table
<base-uri>/config/running/threshold-monitor/nexthop
<base-uri>/config/running/threshold-monitor/route
<base-uri>/config/running/threshold-monitor/vxlan-tunnel
<base-uri>/config/running/threshold-monitor/acl
<base-uri>/config/running/threshold-monitor/acl/ip-in
<base-uri>/config/running/threshold-monitor/acl/ip-out
<base-uri>/config/running/threshold-monitor/acl/ipv6-in
<base-uri>/config/running/threshold-monitor/acl/ipv6-out
<base-uri>/config/running/threshold-monitor/acl/mac-in
<base-uri>/config/running/threshold-monitor/acl/mac-out

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 crossed. The values supported are all, none, raslog, and snmp. Default is all.

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

Usage Guidelines

GET, PUT, PATCH, and DELETE operations are supported.

Examples

Example

The following example uses the PATCH option to update 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>"