FieldsMethodsMember Objects1. Fields
max_auth_errors
| Function name |
Function signature |
| cli_max_auth_errors_set |
int cli_max_auth_errors_set (object:cli obj, int value) |
|
This function sets the maximum authentication errors number after which the connection is terminated. Returns 0 on succes, -1 on failure
|
| cli_max_auth_errors_get |
int cli_max_auth_errors_get (object:cli obj) |
|
This function returns the maximum authentication errors number after which the connection is terminated
|
max_connection_threads
| Function name |
Function signature |
| cli_max_connection_threads_get |
int cli_max_connection_threads_get (object:cli obj) |
|
This function returns the maximum number of threads involved in I/O for this service
|
| cli_max_connection_threads_set |
int cli_max_connection_threads_set (object:cli obj, int value) |
|
This function sets the maximum number of threads involved in I/O for this service. Returns 0 on succes, -1 on failure
|
max_auth_commands
| Function name |
Function signature |
| cli_max_auth_commands_set |
int cli_max_auth_commands_set (object:cli obj, int val) |
|
This function sets the maximum number of commands the CLI service performs before the user logs in. Returns 0 on succes, -1 on failure
|
| cli_max_auth_commands_get |
int cli_max_auth_commands_get (object:cli obj) |
|
This function returns 1 if the secure connection (which start with STARTTLS) are allowed for this service and 0 otherwise
|
max_errors
| Function name |
Function signature |
| cli_max_errors_get |
int cli_max_errors_get (object:cli obj) |
|
This function returns the maximum protocol errors number after which the connection is terminated
|
| cli_max_errors_set |
int cli_max_errors_set (object:cli obj, int value) |
|
This function sets the maximum protocol errors number after which the connection is terminated. Returns 0 on succes, -1 on failure
|
log_host
| Function name |
Function signature |
| cli_log_host_get |
string cli_log_host_get (object:cli obj) |
|
This function returns the host which handles the logging (if the log type is not local)
|
| cli_log_host_set |
int cli_log_host_set (object:cli obj, string value) |
|
This function sets the address of the host that offers log services for Axigen. Returns 0 on succes, -1 on failure
|
log_level
| Function name |
Function signature |
| cli_log_level_get |
int cli_log_level_get (object:cli obj) |
|
This function returns the log level for this service. For more information of service log level, read the Axigen documentation
|
| cli_log_level_set |
int cli_log_level_set (object:cli obj, int val) |
|
This function sets the log level for this service. For more information on service log level, read the Axigen documentation. Returns 0 on succes, -1 on failure
|
min_connection_threads
| Function name |
Function signature |
| cli_min_connection_threads_get |
int cli_min_connection_threads_get (object:cli obj) |
|
This function returns the minimum number of threads involved in I/O for this service
|
| cli_min_connection_threads_set |
int cli_min_connection_threads_set (object:cli obj, int value) |
|
This function sets the minimum number of threads involved in I/O for this service. Returns 0 on succes, -1 on failure
|
log_type
| Function name |
Function signature |
| cli_log_type_get |
string cli_log_type_get (object:cli obj) |
|
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
|
| cli_log_type_set |
int cli_log_type_set (object:cli obj, string value) |
|
This function sets the log type for this service. Valid values for the 'value' parameter are: "internal"(used at logging in a local file), "system"(used at logging in system log) or "remote"(used at logging on a dedicated logging machine)
|
2. Methods
| Function name |
Function signature |
| cli_reset |
int cli_reset (object:cli cli, object:session session) |
|
This function resets the changes made but not yet saved
|
| cli_load |
object:cli cli_load (object:session session, object:context_list context) |
| cli_destroy |
int cli_destroy (object:cli cli) |
|
This function destroys a cli object
|
| cli_save |
int cli_save (object:cli serv, object:session session) |
|
This function saves the cli configuration back to Axigen
|
3. Member Objects
listeners
Functions that apply to member object:
| Function name |
Function signature |
| cli_listeners_get |
object:listeners cli_listeners_get (object:cli cli, object:session s) |
|
This function returns the listeners list of this service. Returns 0 on succes, -1 on failure
|
