Introduced : BIG-IP_v11.0.0
Sets the virtual disk for the specified vCMP guests. The filename of the virtual disk to use for this guest&aposs virtual machines. This is a hint for the system when it looks for virtual disk files. If set, when a guest moves from the configured state to the provisioned state, the system will look first for a virtual disk file with the given filename in /shared/vmdisks and use it if it exists. If it does not exist, the system will create a virtual disk file with the given filename. If not set, the system will create a new virtual disk file and name it after the guest itself.


    in String [] guests,
    in String [] disks


Parameter Type Description
guests String [] A list of vCMP guests.
disks String []  

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.