rmon

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

Resource URIs


URI	Description
/restconf/data/brocade-rmon:rmon	Remote Monitoring Protocol (RMON).


GET URIs	Description
/restconf/data/brocade-rmon:rmon	Remote Monitoring Protocol (RMON).
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%/event-description	Retrieves event description.
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%/log	Retrieves logged events.
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%/event-owner	Retrieves event owner identity.
/restconf/data/brocade-rmon:rmon/alarm-entry=%alarm-index%/alarm-owner	Retrieves alarm owner identity.


POST URIs	Payload	Description
/restconf/data/brocade-rmon:rmon	<event><event-index>(int32)</event-index></event>	Configures RMON event.
/restconf/data/brocade-rmon: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
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%	<event><description>(string)</description></event>	Configures RMON event description.
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%	<event><log>(string)</log></event>	Configures event log.
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%	<event><trap>(string)</trap></event>	Configures event trap.
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%	<event><owner>(string)</owner></event>	Configures event owner.
/restconf/data/brocade-rmon:rmon/event-entry=%event-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.
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%	<alarm><falling-threshold>(uint32)</falling-threshold><event>(int32)</event></alarm>	Configures alarm falling threshold.
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%	<alarm><owner>(string)</owner></alarm>	Configures alarm owner.


DELETE URIs
/restconf/data/brocade-rmon:rmon/event-entry=%event-index%
/restconf/data/brocade-rmon:rmon/alarm-entry=%alarm-index%
/restconf/data/brocade-interface:interface/ethernet=%name%/brocade-rmon:rmon/collection/ether-stats-entry=%ether-stats-index%
/restconf/data/brocade-interface:interface/ethernet=%name%/brocade-rmon:rmon/collection/history-control-entry=%history-control-index%

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:443/restconf/data/brocade-rmon:rmon/event-entry=%event-index%/event-description

None

 <rmon xmlns="urn:brocade.com:mgmt:brocade-rmon">
				<event-entry>
					<event-index>%req_val%</event-index>
					<event-community/>
				</event-entry>
			</rmon>

URI

The following example uses the POST option to configure alarm.

http://host:443/restconf/data/brocade-rmon: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:443/restconf/data/brocade-rmon:rmon/event-entry=%event-index%/event-description

None