Versions Compared

Old Version 1

changes.mady.by.user Tom Polman

Saved on

compared with

New Version Current

changes.mady.by.user Tom Polman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration Article | CA-20220907-TP-65

VDG Sense | API | Functions | Status

Image Added

View file
nameCA-20220907-TP-65.pdf

Table of Contents

Note: This function requires an API license.

...

This function requires the System Status plugin to be enabled. For more information about configuring the System status plugin, click here/wiki/spaces/KB/pages/973996093. If System Status plugin is not running, an errorcode = “0” will be given.

Request

Code Block
command=getHardwareStatus

Response

Code Block
<result errorcode="0">
  <hardwarestatus>
    <status>[Ok|Warning|Error]</status>
    <description>[string]</description>
  </hardwarestatus>
 </result>

node

value

remarks

/result

@errorcode

[number]

See error codes below

/result/hardwarestatus

status

[Ok

Warning

Error]

The status level.

description

[string]

Optional description of the status level.

error code

description

remarks

0

Ok

Ok, no error

-54

System Status plugin not active

The System Status plugin is not enabled or Sense PluginManager is not running

Results

If ok, the following will be returned:

Code Block
<hardwarestatus>
  <status>Ok</status>
</hardwarestatus>

If failover is active, the following will be returned:

Code Block
<hardwarestatus>
  <status>Error</status>
  <description>failover server is active</description>
</hardwarestatus>

In case of a Raid failure, the following will be returned:

Code Block
<hardwarestatus>
  <status>Error</status>
 <description>[raid-status]</description>
</hardwarestatus>

[Raid-status] is a textual representation of the raid status. It is different for AMCC and LSI raid systems.

...

A degraded AMCC unit will generate the following response:

Code Block
<hardwarestatus>
   <status>Error</status>
   <description>AMCC: Server 10.0.0.10, RAID unit 2: Degraded</description>
</hardwarestatus>

Only the last unit or drive that has a failure is reported in the XML response. If an error occurs the systems raid configuration software should be consulted for more information a repair.

...