Introduced : BIG-IP_v11.2.0
Initiates an install of a software image on all blades installed on one chassis.


    in String volume,
    in String product,
    in String version,
    in String build,
    in boolean create_volume,
    in boolean reboot,
    in boolean retry


Parameter Type Description
volume String Installation slot (HD slot) to create. This will be the same on all blades.
product String The product you are installing (ex: BIGIP).
version String The version of product (ex: 11.2.0).
build String The build number you are installing (ex: 1943.0).
create_volume boolean If true, then create the target volume before installing.
reboot boolean If true, then reboot into the target volume after the install is finished.
retry boolean If true, then keep trying to install if the system does not have enough resources to finish the install the first time.

Return Type

Type Description


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.