You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ClearLog

ClearLog

Type

SwitchKit API message

Description

The ClearLog message is used as an operations, administration and maintenance feature in the Converged Services Administrator (CSA) to clear log files. You can choose among different options to clear log files.

Sent by

Application or CSA

How to use

To use a ClearLog message, construct the message and set the LoggingBitMask:

SKC_ClearLog cl;

UBYTE log_bit_mask = SK_CLEAR_MSG_LOG |

SK_CLEAR_SOCKET_LOG

cl.setLoggingBitMask(log_bit_mask);

Argument Values

The following table shows the common values of the LoggingBitMask argument. You can combine two or more values with a logical OR to clear several logs at once.

Clear individual log files using the following values:

Argument Value | Description
--- | ---
SK_CLEAR_MSG_LOG | Clears only the messages log file.
SK_CLEAR_MAINT_LLC_LOG | Clears only the LLC maintenance log.
SK_CLEAR_SOCKET_LOG | Clears only the socket log file.
SK_CLEAR_ALARM_LOG | Clears only the alarm log file.
SK_CLEAR_MAINT_SWMGR_LOG | Clears only the SwitchManager maintenance log file.

Clear groups of log files using the following values:

Argument Value | Description
SK_CLEAR_ALL_SK_LOGS | Clears all the SwitchKit logs.
SK_CLEAR_ALL_LLC_LOGS | Clears all LLC logs, including: SK_CLEAR_MSG_LOG | SK_CLEAR_MAINT_LLC_LOG | SK_CLEAR_SOCKET_LOG
SK_CLEAR_ALL_SWMGR_LOGS | Clears all SwitchManager logs, including: SK_CLEAR_ALARM_LOG| SK_CLEAR_MAINT_SWMGR_LOG

C Structure

typedef struct {

UBYTE LoggingBitMask;

} SK_ClearLog;

C Structure Response

typedef struct {

int Status;

} SK_ClearLogAck;

C++ Class

class SKC_ClearLog : public SKC_ToolkitMessage {

public:

UBYTE getLoggingBitMask() const;

void setLoggingBitMask(UBYTE x);

};

C++ Class Response

class SKC_ClearLogAck : public SKC_ToolkitAck {

public:

int getStatus() const;

void setStatus(int x);

};

CSA. GUI-based tool used to configure, provision and monitor a Excel platform related to, for example, SIP, H.323, and VDAC Resouce Attributes.
See Converged Services Administrator.