Table Of Contents

AuditTrail Management Functions

purge_audit_trail_records

read_audit_trail_records

AuditTrail Management Functions

---

This chapter provides information about the following audit trail management functions:

•purge_audit_trail_records

•read_audit_trail_records

purge_audit_trail_records

Synopsis

purge_audit_trail_records ($token, $num) 

Description

This function purges the audit trail logs that contain records of user activities. It removes the older records that exceed the num parameter.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.
num	Integer, mandatory	Valid integer value	The number (quantity) of the log records to keep.

Return

This function returns a Cisco::CLM::Common::Status object.

Error and Exception

If a system error prevents the operation from completing, a RemoteException is thrown.

When an error occurs, the Status object returns the none SUCCESS error code and error message.

read_audit_trail_records

Synopsis

read_audit_trail_records ($token, $numRecords) 

Description

This function retrieves the audit trail logs that contain records of user activities. If numRecords is set to 0, it returns all records in the system.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.
numRecords	Integer, mandatory	Valid integer value	The number (quantity) of the log records to retrieve.

Return

This function returns an array of Cisco::CLM::Common::AuditTrail object.

Error and Exception

If a system error prevents the operation from completing, a RemoteException is thrown.

When an error occurs, this function returns null. An array of length zero indicates that no record was found.