Coyote Point Systems Equalizer GX Series, Administration Manual

Page: 692 / 866

Smart Control
Server Instance Class (si)
The following are Server Instance parameters. Refer to Server Pool and Server Instance
Commands for descriptions.
Parameters
name(string)
probe_port (int)
quiesce (bool)
sp (object): The server pool that this server instance belongs to, as retrieved using
srvpool::getByName().
weight (int)
hot_spare (bool)
probe_l4 (bool)
maxconn (int)
persist_override (bool)
strict_maxconn (bool)
Methods
getByName(object srvpool, string name)
Description:
Fetch the server instance named
‘name’
from the server pool object
srvpool
. The server pool object
should have been previously fetched with
srvpool::getByName().
Returns:
On success: server instance object populated with all of its properties. On failure: An exception with a message
and an error code.
Example:
// Fetch a server instance named ‘sv00’
$sp = srvpool::getByName(“sp00”);
$si = si::getByName($sp, "sv00");
getStatusDescription()
Description:
Get the status of this server instance as a string.
Returns:
A string containing the status of this server instance.
Example:
$sp = srvpool::getByName(“sp00”);
$si = si::getByName($sp, "sv00");
// print the status – accessible using ‘lastrun’ command.
echo $si->getStatusDescription();
692 Copyright © 2014 Coyote Point Systems, A Subsidiary of Fortinet, Inc.