- Solutions
-
- File Server: Ransomware Protection
- File Server: File Copy
- File Server: Audit File Access
- File Server: Storage growth reporting
- Licensing/Pricing
- Contact
This help page is for version 5.6. 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.
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
XML = {0|1} - defaults to 0
Example
Output (server|group^group)
XML Example
XML Output
Returns a list of groups, with their name, full path name, group ID, and group ID for the group's parent.
Optional Parameters
XML = {0|1} - defaults to 0
Example
Output (name|full path|id|parentID)
XML Example
XML Output
Returns information about all monitors owned by a particular computer.
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via the GET_SERVER_LIST (XML output) above.
Optional Parameters
FORMAT_DATE - 0 to always output as dd-mm-yyyy hh:mm:ss (24 hour hh), or 1 to use the same format that the existing reports use (which can be customized). Defaults to 0.
Example
Output (XML)
Pro Tip: If you set the following registry value, you can see Group, Server and Monitor IDs directly in the navigation pane of the Console.
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
Output (XML)
Put the server into immediate maintenance mode.
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via GET_SERVER_LIST (XML output) above.
- or -
GID - Group ID for the group that contains target computers (including those in child-groups). Group IDs can be obtained from GET_GROUP_LIST.
- or -
MID - Monitor ID for the specific monitor that should be affected. Monitor IDs can be obtained from GET_MONITOR_INFO.
MINUTES - time in minutes that the server should remain in maintenance mode before it automatically reverts to normal monitoring
Example
Output
Put the server back into normal monitoring mode.
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via GET_SERVER_LIST (XML output) above.
- or -
GID - Group ID for the group that contains target computers (including those in child-groups). Group IDs can be obtained from GET_GROUP_LIST.
- or -
MID - Monitor ID for the specific monitor that should be affected. Monitor IDs can be obtained from GET_MONITOR_INFO.
Example
Output
Request the specified monitor be run immediately
Required Parameters
MID - Monitor ID for the monitor to run immediately. Monitor IDs can be obtained from GET_MONITOR_INFO above.
Optional Parameters
FORCE - 1 to run the monitor even if it's disabled or the server is in maintenance. Defaults to 0
Example
Output
Scan an IP address range for new servers that aren't being monitored, and run Smart Config for the new servers. The Discovery and Smart Config procedures can take some time, so an OK result means that the process has been started.
Required Parameters
START - Start of IP address range
END - End of IP address range
Example
Output
Add and optionally configure the named server
Required Parameters
SERVER - name of the server that should be added. If the server already exists, it will be operated on (WIN, WMI and GROUP will not have an effect in that case).
Optional Parameters
WIN={0|1} - defaults to 0. Set to 1 if this is a Windows server.
WMI={0|1} - defaults to 0. Set to 1 if WMI polling should happen to collect System Details information for the server status report
CONFIG_PATH - defaults to none. Full path to a .cxml config file that specifies a configuration that should be applied to the new server.
.cxml files are created by exporting a computer's configuration, or by using the EXPORT_SERVER API below. The file must be on the same computer as PA Storage Monitor is running on.
GROUP - defaults to none (which implies the top level group). The full path to the group that the server should be placed in, for example: Servers/Devices^Seattle^Exchange Servers (where the ^ delimits group names).
Example
Output
Delete the named server, along with all of its monitors
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via the GET_SERVER_LIST (XML output) above.
{deprecated} SERVER - name of the server that should be deleted
Example
Output
Exports the configuration of the specified server in a .cxml file. Per-server passwords (if any) are NOT exported.
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via the GET_SERVER_LIST (XML output) above.
- or -
SERVER - Name of the computer to target. If there are multiple computers with the same name (perhaps at different locations), which one is returned is not defined.
Optional Parameters
PATH - Full path to the output file. If this is not given, the file will be saved to C:\Program Files\PA Storage Monitor\Config\Backup\Export_Computer_{CID}.cxml
Note: Be careful where these files are saved as some monitor configurations might contain sensitive information.
Example
Output
Sets a custom property on a server. If the property value is empty, the custom property is removed.
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via the GET_SERVER_LIST (XML output) above.
- or -
SERVER - Name of the computer to target. If there are multiple computers with the same name (perhaps at different locations), which one is returned is not defined.
PROPNAME - Name of the property to set
PROPVAL - Value of the property to set
Example
Output
Retrieves a custom property on a server. If the property is not defined, an empty value is returned.
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via the GET_SERVER_LIST (XML output) above.
- or -
SERVER - Name of the computer to target. If there are multiple computers with the same name (perhaps at different locations), which one is returned is not defined.
PROPNAME - Name of the property to retrieve
Example
Output
Add the given group if it doesn't already exist
Required Parameters
NAME - Full of the group name. For example, a group named "Exchange Servers" under the top "Servers\Devices" would set NAME to Servers\Devices^Exchange%20Servers (delimit groups with ^, URL encode, so a space becomes %20)
Example
Output
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
NAME - Full of the group name. For example, a group named "Exchange Servers" under the top "Servers\Devices" would set NAME to Servers\Devices^Exchange%20Servers (delimit groups with ^, URL encode, so a space becomes %20)
Example
Output
Once a day and any time the monitoring service starts, the configuration is backed up to C:\Program Files\PA Storage Monitor\Config\Backup. Using this API command, you can force the backup to happen on demand.
Example
Output
A new backup file is created in C:\Program Files\PA Storage Monitor\Config\Backup
Pass a server name and get forwarded to that server's status report
Required Parameters
CID - Computer ID for the computer to target for the operation. Computer IDs can be obtained via the GET_SERVER_LIST (XML output) above.
{deprecated} SERVER - name of the server
Example
Output
Browser gets redirected to the given server's status report page