This help page is for version 4.2. The latest available help is for version 9.4.
PA Storage Monitor has a simple API for automating some basic operations.
To protect the system from un-authorized requests, there are two security precautions that are required:
Requests are made via HTTPS. The format of the requests is:
Additional optional parameters can be appended to the URL using the pattern:
All API commands return data as simple text. Successful commands return as XML, or in the following format:
All errors are returned as:
Below are the supported commands. The command name should be inserted where {command} is shown in the example above.
GET_SERVER_LIST |
Returns a list of servers and the group that the server is in. The XML version also shows the computer's internal ID. Optional Parameters Example https://server:81?API=GET_SERVER_LIST&KEY=msa8gbk4j78dbglaj
Output (server|group^group)
:START:
DNVISTA|Servers/Devices 192.168.2.5|Servers/Devices POWERADMIN.COM|Servers/Devices^Boston OPSMON02|Servers/Devices^Servers^Office ARCHIVE|Servers/Devices :END: XML Example https://server:81?API=GET_SERVER_LIST&KEY=msa8gbk4j78dbglaj&XML=1
XML Output
<?xml version="1.0" ?>
<servers> <server name="DNVISTA" group="Servers/Devices^Boston^Servers" id="1" /> <server name="192.168.2.5" group="Servers/Devices^Kansas City" id="2" /> <server name="POWERADMIN.COM" group="Servers/Devices^External" id="4" /> <server name="OPSMON02" group="Servers/Devices^Boston^Servers" id="5" /> <server name="ARCHIVE" group="Servers/Devices^Boston^Servers" id="8" /> </servers> |
GET_MONITOR_INFO |
Returns information about all monitors owned by a particular computer. Required Parameters Optional Parameters Example https://server:81?API=GET_MONITOR_INFO&KEY=msa8gbk4j78dbglaj&CID=371
&FORMAT_DATE=1 Output (XML)
<?xml version="1.0" ?>
<monitors> <monitor id="13" status="OK" depends_on="" title="Check Free Disk Space" lastRun="16-10-2010 5:54:10" nextRun="16-10-2010 11:54:10" errText="" errorActionIDs="1,3,8" fixedActionIDs="" /> <monitor id="74" status="Alert" depends_on="132,5" title="Ping OPSMON02" lastRun="16-10-2010 6:25:12" nextRun="16-10-2010 6:26:12" errText="OPSMON02 is not responding to ping requests [in error for 2m 3s]" errorActionIDs="7,3" fixedActionIDs="3" /> </monitors> |
GET_ACTION_INFO |
Returns a list describing all the actions in the system (these IDs are used in the errorActionIDs and fixedActionIDs attributes returned from GET_MONITOR_INFO Example https://server:81?API=GET_ACTION_INFO&KEY=msa8gbk4j78dbglaj
Output (XML)
<?xml version="1.0" ?>
<actions> <action id="1" type="Message Box" typeID="3" title="Message Box" /> <action id="2" type="Write to a Text Log File" typeID="6" title="Write to ServerEvents.txt log file" /> <action id="6" type="Start, Stop or Restart a Service" typeID="5" title="Restart stopped service on monitored computer" /> </actions> |
START_MAINTENANCE |
Put the server into immediate maintenance mode. Required Parameters Example https://server:81?API=START_MAINTENANCE&KEY=msa8gbk4j78dbglaj &CID=37&MINUTES=15
Output :OK:
|
END_MAINTENANCE |
Put the server back into normal monitoring mode. Required Parameters Example https://server:81?API=END_MAINTENANCE&KEY=msa8gbk4j78dbglaj&CID=37
Output :OK:
|
RUN_NOW |
Request the specified monitor be run immediately Required Parameters Example https://server:81?API=RUN_NOW&KEY=msa8gbk4j78dbglaj&MID=4721
Output :OK:
|
ADD_SERVER |
Add and optionally configure the named server Required Parameters Optional Parameters Example https://server:81?API=ADD_SERVER&KEY=msa8gbk4j78dbglaj&SERVER=MAILSRV2&WIN=1 &WMI=1&CONFIG_PATH=C:\Configs\Mail+Config.cxml
Output :OK:
|
DELETE_SERVER |
Delete the named server, along with all of its monitors Required Parameters Example https://server:81?API=DELETE_SERVER&KEY=msa8gbk4j78dbglaj&CID=125
Output :OK:
|
ADD_GROUP |
Add the given group if it doesn't already exist Required Parameters Example https://server:81?API=ADD_GROUP&KEY=msa8gbk4j78dbglaj&NAME=Servers\Devices^New%20York^Web
Output :OK:
|
DELETE_GROUP |
Delete the named group. If it contains child groups or servers, they will become orphaned and moved to the top Servers\Devices group the next time the monitoring service is restarted. Required Parameters Example https://server:81?API=DELETE_GROUP&KEY=msa8gbk4j78dbglaj&NAME=Servers\Devices^New%20York^Web
Output :OK:
|
GOTO_SERVER_REPORT |
Pass a server name and get forwarded to that server's status report Required Parameters Example https://server:81?API=GOTO_SERVER_REPORT&KEY=msa8gbk4j78dbglaj&CID=362
Output |