Introduced : BIG-IP_v9.2.0
Gets text which contains boot image information, in the form of “name=value” pairs. The text includes information about what&aposs installed in each of the boot locations in the device. While this method is not officially deprecated, it is preferred to use get_software_status, as that method is a newer method which yields much the same information in a more rigorous and controlled manner.


char [] get_boot_image_information(
    in boolean save_active_config


Parameter Type Description
save_active_config boolean The boolean indicating whether we should backup the configuration on the active boot location for the installer.

Return Type

Type Description
char [] The boot image information file data.


Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also


The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.