Coyote Point Systems Equalizer GX Series, Administration Manual

Page: 686 / 866

Smart Control
getInstanceList()
Description:
List server instances for this server pool from the configuration.
Returns: A map with the following keys:
si_list : list of server instance names as strings
message: a status message indicating success or failure of the operation
status: a status code: 0 indicates success, nonzero indicates failure
Example:
// Get list of server instances from server pool ‘sp00’
$sp = srvpool::getByName(“sp00”);
$list = $sp->getInstanceList();
// loop through the names in the “si_list”
for ($counter = 0; $counter < count($list["si_list"]); $+) {
// each name in the list is $list["si_list"][$counter]
}
getStatusDescription()
Description:
Get the status of this server pool as a string.
Returns:
A string containing the status of this server pool.
Example:
$sp = srvpool::getByName(“sp00”);
// print the status – accessible using ‘lastrun’ command.
echo $sp->getStatusDescription();
getStatusResp()
Description:
Get the status of this server pool as a numeric value.
Returns : A numeric value indicating the status:
0: There are no problems with this server pool.
1: There is an ‘informational’ status available, but the server pool is functional.
2: There is a problem with this server pool.
Example:
// If there is a problem with this pool, print the status (accessible using
‘lastrun’ command).
$sp = srvpool::getByName(“sp00”);
if ($sp->getStatusResp() == 2) {
echo $sp->getStatusDescription();
}
686 Copyright © 2014 Coyote Point Systems, A Subsidiary of Fortinet, Inc.