formula
Description
Provides methods to access and modify formulas.
Namespace:
formula
Method: getCombinedFormulaDataByServerIds
Description:
Return the list of formulas a server and all his groups have.
Parameters:
-
string sessionKey
-
string formulaName
-
int array sids
Returns:
-
array :
-
struct formula data
-
int "system_id"
-
string "minion_id"
-
struct "formula_values" - saved formula values
-
Method: getCombinedFormulasByServerId
Description:
Return the list of formulas a server and all his groups have.
Parameters:
-
string sessionKey
-
int sid - the system ID
Returns:
-
string array the list of formulas
Method: getFormulasByGroupId
Description:
Return the list of formulas a server group has.
Parameters:
-
string sessionKey
-
int systemGroupId
Returns:
-
string array the list of formulas
Method: getFormulasByServerId
Description:
Return the list of formulas directly applied to a server.
Parameters:
-
string sessionKey
-
int sid - the system ID
Returns:
-
string array the list of formulas
Method: getGroupFormulaData
Description:
Get the saved data for the specific formula against specific group
Parameters:
-
string sessionKey
-
int groupId
-
string formulaName
Returns:
-
struct the saved formula data
Method: getSystemFormulaData
Description:
Get the saved data for the specific formula against specific server
Parameters:
-
string sessionKey
-
int sid - the system ID
-
string formulaName
Returns:
-
struct the saved formula data
Method: listFormulas
Description:
Return the list of formulas currently installed.
Parameters:
-
string sessionKey
Returns:
-
string array the list of formulas
Method: setFormulasOfGroup
Description:
Set the formulas of a server group.
Parameters:
-
string sessionKey
-
int systemGroupId
-
string array formulas
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: setFormulasOfServer
Description:
Set the formulas of a server.
Parameters:
-
string sessionKey
-
int sid - the system ID
-
string array formulas
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: setGroupFormulaData
Description:
Set the formula form for the specified group.
Parameters:
-
string sessionKey
-
int groupId
-
string formulaName
-
struct content - struct containing the values for each field in the form
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: setSystemFormulaData
Description:
Set the formula form for the specified server.
Parameters:
-
string sessionKey
-
int systemId
-
string formulaName
-
struct content - struct content with the values for each field in the form
Returns:
-
int - 1 on success, exception thrown otherwise.