Introduced : BIG-IP_v11.0.0
Creates vCMP guests. If you set the guest state to GUEST_STATE_PROVISIONED or higher the system creates and attaches a virtual disk to the guest if needed.


    in String [] guests,
    in String [] hostnames,
    in String [] images,
    in Common__IPNetmask [] addresses,
    in String [] gateways,
    in String [] [] vlans


Parameter Type Description
guests String [] A list of vCMP guests to create.
hostnames String [] A list of hostnames (FQDN) for the guests. (if left empty, the system will choose a name if possible based on guest name or .localdomain or if all else fails, localhost.localdomain).
images String [] A list of initial TMOS software images for the guests.
addresses IPNetmask [] A list of management IP addresses for the guests (can be empty, but that leaves only console access).
gateways String [] A list of gateway IP addresses for the guests (can be empty, but that leaves only console access).
vlans String [] [] A list of (lists of) vlans for the 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.