Introduced : BIG-IP_v10.0.1
A structure that contains information on software status. This includes items like product, version, build, and (live install) completion status.
Member Type Description
installation_id InstallationID The location for the status.
product String The product you are installing (ex: BIGIP) (or, product which is installed).
version String The version of product (ex: 9.6.0).
build String The build number you are installing.
base_build String The base build (used for hotfixes).
active boolean Whether the boot location is active.
edition String Gives the edition, e.g.”Hotfix HF4” (used for hotfixes).
status String A string indicating the status of the live install process. The status strings are “none”, “audited”, “retry”, “upgrade needed”, “waiting for image”, “installing nn.mmm pct”, “complete”, “cancelling”, “cancelled”, and “failed”. The “failed” string may have text giving a reason after it. The “waiting for image” string may have further text after it describing the image being awaited. A client should ignore any strings returned other than these. You can use the status field to monitor the completion status of a live install operation in process. When checking status, you should ensure that the product, version, and build reflect the software whose status you are interested in (because there are a few scenarios where the product, version, and build for a volume may not be updated as quickly as you might expect).

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.