rmon

Configures, modifies, or retrieves Remote Monitoring Protocol (RMON) information.

Resource URIs

URI Description
<base_URI>/config/running/rmon Remote Monitoring Protocol (RMON).
GET URIs Description
<base_URI>/config/running/rmon Remote Monitoring Protocol (RMON).
<base_URI>/config/running/rmon/event/{event-index}/description Retrieves event description.
<base_URI>/config/running/rmon/event/{event-index}/log Retrieves logged events.
<base_URI>/config/running/rmon/event/{event-index}/trap Retrieves event trap information.
<base_URI>/config/running/rmon/event/{event-index}/owner Retrieves event owner identity.
<base_URI>/config/running/rmon/alarm/{alarm-index}/event Retrieves event for falling alarm.
<base_URI>/config/running/rmon/alarm/{alarm-index}/owner Retrieves alarm owner identity.
POST URIs Payload Description
<base_URI>/config/running/rmon <event><event-index>(int32)</event-index></event> Configures RMON event.
<base_URI>/config/running/rmon <alarm><alarm-index>(int32)</alarm-index><snmp-oid>(string)</snmp-oid><interval>(int32)</interval><type>(string)</type><rising-threshold>(unit32)</rising-threshold><event>(int32)</event></alarm> Configures RMON alarm.
PATCH URIs Payload Description
<base_URI>/config/running/rmon/event/{event-index} <event><description>(string)</description></event> Configures RMON event description.
<base_URI>/config/running/rmon/event/{event-index} <event><log>(string)</log></event> Configures event log.
<base_URI>/config/running/rmon/event/{event-index} <event><trap>(string)</trap></event> Configures event trap.
<base_URI>/config/running/rmon/event/{event-index} <event><owner>(string)</owner></event> Configures event owner.
<base_URI>/config/running/rmon/alarm/{alarm-index} <alarm><snmp-oid>(string)</snmp-oid><interval>(int32)</interval><type>(string)</type><rising-threshold>(unit32)</rising-threshold><event>(int32)</event></alarm> Configures RMON alarm.
<base_URI>/config/running/rmon/alarm/{alarm-index} <alarm><falling-threshold>(uint32)</falling-threshold><event>(int32)</event></alarm> Configures alarm falling threshold.
<base_URI>/config/running/rmon/alarm/{alarm-index} <alarm><owner>(string)</owner></alarm> Configures alarm owner.
PUT URIs Payload Description
<base_URI>/config/running/rmon/event/{event-index} <description>(string)</description> Configures RMON event description.
<base_URI>/config/running/rmon/event/{event-index}/log <log>(string)</log> Configures event log.
<base_URI>/config/running/rmon/event/{event-index}/trap <trap>(string)</trap> Configures event trap.
<base_URI>/config/running/rmon/event/{event-index}/owner <owner>(string)</owner> Configures event owner.
<base_URI>/config/running/rmon/alarm/{alarm-index} <alarm><falling-threshold>(uint32)</falling-threshold><event>(int32)</event></alarm> Configures alarm falling threshold.
<base_URI>/config/running/rmon/alarm/{alarm-index}/owner <owner>(string)</owner> Configures alarm owner.
DELETE URIs
<base_URI>/config/running/rmon/event/{event-index}
<base_URI>/config/running/rmon/event/{event-index}/description
<base_URI>/config/running/rmon/event/{event-index}/log
<base_URI>/config/running/rmon/event/{event-index}/trap
<base_URI>/config/running/rmon/event/{event-index}/owner
<base_URI>/config/running/rmon/alarm/{alarm-index}
<base_URI>/config/running/rmon/alarm/{alarm-index}/event
<base_URI>/config/running/rmon/alarm/{alarm-index}/owner

Parameters

alarm-index
Configures RMON alarm. The range is from 1 to 65535.
rising-threshold
Configures rising threshold. The range is from 0 to 4294967295.
falling-threshold
Configures falling threshold. The range is from 0 to 4294967295.
snmp-oid
Configures SNMP OID.
interval
Configures alarm sample interval.
event-index
Configures RMON event. The range is from 1 to 65535.

Usage Guidelines

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

Examples

URI

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

http://host:80/rest/config/running/rmon/event/200/description

None

<description xmlns="urn:brocade.com:mgmt:brocade-rmon" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/rmon/event/200/description">hi_32768</description>

URI

The following example uses the POST option to configure alarm.

http://host:80/rest/config/running/rmon

<alarm>
  <alarm-index>100</alarm-index>
  <snmp-oid>1.3.6.1.2.1.16.1.1.1.5.65535</snmp-oid>
  <interval>10</interval>
  <type>absolute</type>
  <rising-threshold>10000</rising-threshold>
  <event>100</event>
</alarm>

None

URI

The following example uses the DELETE option to remove RMON event.

http://host:80/rest/config/running/rmon/event/100

None

None