system-monitor

Resource URIs

GET URIs Description
<base_URI>/config/running/system-monitor Retrieves FRU threshold and alert setting.
<base_URI>/config/running/system-monitor/fan Retrieves threshold and alert setting for component: FAN.
<base_URI>/config/running/system-monitor/power Retrieves threshold and alert setting for component: POWER SUPPLY.
<base_URI>/config/running/system-monitor/temp Retrieves threshold and alert setting for component: TEMPERATURE SENSOR.
<base_URI>/config/running/system-monitor/cid-card Retrieves threshold and alert setting for component: CIS-CARD.
<base_URI>/config/running/system-monitor/sfp Retrieves threshold and alert setting for component: SFP.
<base_URI>/config/running/system-monitor/compact-flash Retrieves threshold component: COMPACT-FLASH.
<base_URI>/config/running/system-monitor/mm Retrieves threshold setting for component: MM.
<base_URI>/config/running/system-monitor/linecard Retrieves threshold and alert setting for component: LINECARD.
<base_URI>/config/running/system-monitor/sfm Retrieves threshold setting for component: SFM.
<base_URI>/config/running/system-monitor/port Retrieves threshold, alert and action settings for Port CRC Monitoring
PUT URIs Payload Description
<base_URI>/config/running/system-monitor/fan/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of the Fan component.
<base_URI>/config/running/system-monitor/fan/threshold/down-threshold <down-threshold>(unit32)</down-threshold> Configures minimum number contributing to DOWN state of the Fan component.
<base_URI>/config/running/system-monitor/fan/alert/state <state>removed</state> Configures alerts for Fan state.
<base_URI>/config/running/system-monitor/fan/alert/action <action>raslog</action> Configure action to be taken.
<base_URI>/config/running/system-monitor/power/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of the Power component.
<base_URI>/config/running/system-monitor/power/threshold/down-threshold <down-threshold>(unit32)</down-threshold> Configures minimum number contributing to DOWN state of the Power component.
<base_URI>/config/running/system-monitor/power/alert/state <state>removed</state> Configures alerts for Power state.
<base_URI>/config/running/system-monitor/power/alert/action <action>raslog</action> Configure action to be taken.
<base_URI>/config/running/system-monitor/temp/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of the Temperature component.
<base_URI>/config/running/system-monitor/temp/threshold/down-threshold <down-threshold>(unit32)</down-threshold> Configures minimum number contributing to DOWN state of the Temperature component.
<base_URI>/config/running/system-monitor/cid-card/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of the CID crash.
<base_URI>/config/running/system-monitor/cid-card/threshold/down-threshold <down-threshold>(unit32)</down-threshold> Configures minimum number contributing to DOWN state of the CID crash.
<base_URI>/config/running/system-monitor/cid-card/alert/state <state>removed</state> Configures alerts for CID crash state.
<base_URI>/config/running/system-monitor/cid-card/alert/action <action>raslog</action> Configure action to be taken.
<base_URI>/config/running/system-monitor/compact-flash/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of the compact flash.
<base_URI>/config/running/system-monitor/compact-flash/threshold/down-threshold <down-threshold>(unit32)</down-threshold> Configures minimum number contributing to DOWN state of the compact flash.
<base_URI>/config/running/system-monitor/MM/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of MM.
<base_URI>/config/running/system-monitor/LineCard/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of LineCard.
<base_URI>/config/running/system-monitor/LineCard/threshold/down-threshold <down-threshold>(unit32)</down-threshold> Configures minimum number contributing to DOWN state of the LineCard.
<base_URI>/config/running/system-monitor/LineCard/alert/state <state>inserted</state> Configures alerts for LineCard state.
<base_URI>/config/running/system-monitor/LineCard/alert/action <action>raslog</action> Configure action to be taken.
<base_URI>/config/running/system-monitor/port <port /> Configures Port CRC Monitoring.
<base_URI>/config/running/system-monitor/SFM/threshold/marginal-threshold <marginal-threshold>(unit32)</marginal-threshold> Configures minimum number contributing to MARGINAL state of SFM.
<base_URI>/config/running/system-monitor/SFM/threshold/down-threshold <down-threshold>(unit32)</down-threshold> Configures minimum number contributing to DOWN state of SFM.

Parameters

action
Specifies the response type.
all
Specifies that e-mail and RASLog messaging are used.
email
Specifies that an e-mail message is sent.
none
Specifies that no message is sent.
raslog
Specifies RASLog messaging.
state
Specifies the hardware state to be monitored.
all
Specifies that all hardware states are monitored.
faulty
Specifies that hardware is monitored for faults.
inserted
Specifies that the insertion state of hardware is monitored.
none
Specifies that no hardware states are monitored.
on
Specifies that the hardware on/off state is monitored.
removed
Specifies that the removal of hardware is monitored.
down-threshold
Specifies an integer value that, when exceeded, indicates when hardware is down.
marginal-threshold
Specifies an integer value that, when exceeded, indicates when hardware is operating marginally.

Usage Guidelines

GET, POST, 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/system-monitor

None

<system-monitor xmlns="urn:brocade.com:mgmt:brocade-system-monitor" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/system-monitor">
  <fan y:self="/rest/config/running/system-monitor/fan">
    <threshold y:self="/rest/config/running/system-monitor/fan/threshold">
      <marginal-threshold>1</marginal-threshold>
      <down-threshold>2</down-threshold>
    </threshold>
    <alert y:self="/rest/config/running/system-monitor/fan/alert">
      <state>removed</state>
      <action>raslog</action>
    </alert>
  </fan>
  <power y:self="/rest/config/running/system-monitor/power">
    <threshold y:self="/rest/config/running/system-monitor/power/threshold">
      <marginal-threshold>3</marginal-threshold>
      <down-threshold>4</down-threshold>
    </threshold>
    <alert y:self="/rest/config/running/system-monitor/power/alert">
      <state>removed</state>
      <action>raslog</action>
    </alert>
  </power>
  <temp y:self="/rest/config/running/system-monitor/temp">
    <threshold y:self="/rest/config/running/system-monitor/temp/threshold">
      <marginal-threshold>1</marginal-threshold>
      <down-threshold>2</down-threshold>
    </threshold>
  </temp>
  <cid-card y:self="/rest/config/running/system-monitor/cid-card">
    <threshold y:self="/rest/config/running/system-monitor/cid-card/threshold">
      <marginal-threshold>1</marginal-threshold>
      <down-threshold>0</down-threshold>
    </threshold>
    <alert y:self="/rest/config/running/system-monitor/cid-card/alert">
      <state>removed</state>
      <action>raslog</action>
    </alert>
  </cid-card>
  <sfp y:self="/rest/config/running/system-monitor/sfp">
    <alert y:self="/rest/config/running/system-monitor/sfp/alert">
      <state>none</state>
      <action>none</action>
    </alert>
  </sfp>
  <compact-flash y:self="/rest/config/running/system-monitor/compact-flash">
    <threshold y:self="/rest/config/running/system-monitor/compact-flash/threshold">
      <marginal-threshold>1</marginal-threshold>
      <down-threshold>0</down-threshold>
    </threshold>
  </compact-flash>
  <MM y:self="/rest/config/running/system-monitor/MM">
    <threshold y:self="/rest/config/running/system-monitor/MM/threshold">
      <marginal-threshold>1</marginal-threshold>
      <down-threshold>0</down-threshold>
    </threshold>
  </MM>
  <LineCard y:self="/rest/config/running/system-monitor/LineCard">
    <threshold y:self="/rest/config/running/system-monitor/LineCard/threshold">
      <marginal-threshold>1</marginal-threshold>
      <down-threshold>0</down-threshold>
    </threshold>
    <alert y:self="/rest/config/running/system-monitor/LineCard/alert">
      <state>removed</state>
      <action>raslog</action>
    </alert>
  </LineCard>
  <SFM y:self="/rest/config/running/system-monitor/SFM">
    <threshold y:self="/rest/config/running/system-monitor/SFM/threshold">
      <marginal-threshold>1</marginal-threshold>
      <down-threshold>0</down-threshold>
    </threshold>
  </SFM>
</system-monitor>

URI

The following example uses the PUT option to configure fan marginal threshold.

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

<marginal-threshold>1</marginal-threshold>

None