Introduced : BIG-IP_v11.0.0
Sets the initial TMOS software image for the specified vCMP guests. This image is used only when initially creating the virtual disks. After initial creation, the typical Live Install process should be used on the virtual machines to manage software upgrades. The image filename must match a verified software image file that exists in the /shared/images directory.


    in String [] guests,
    in String [] images


Parameter Type Description
guests String [] A list of vCMP guests.
images String [] A list of initial TMOS software images for the specified vCMP guests.

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.