Documentation Center

log_install

Log a software (or package) install or upgrade.

Description

This function is invoked whenever software (or a package) is installed or upgraded, to log details into the system log file.

Parameters

action
log_install
package
Identifying name of the package or the delivery group.
package_version
The version of the package, if the 'package' param is provided.

Example URL

http://<host>:<port>/<context>/web/admin.xql?action=log_install&package=<value>&package_version=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

Failed Result

In the case of an error, this function returns a standard API result element with a non-zero statusCode (such as, <result status='FAIL' statusCode='200' message='Localized Failure Message' messageKey='message.key'/>).  Refer to API Error Code Reference.

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available.