Introduced : BIG-IP_v12.1.0
Installs the configurations contained in the specified single configuration file (SCF) to the local device.


    in String filename,
    in LoadMode load_flag,
    in String passphrase,
    in String tarfile,
    in boolean merge


Parameter Type Description
filename String The file name of the configuration file to install. length limit: 255.
load_flag LoadMode The flag specifying the type of load to perform.
passphrase String The passphrase used to decrypt the file so we can install it.
tarfile String The TAR file used to store system files referenced by the SCF.
merge boolean The flag indicating whether the configuration should be merged into the current running config rather than overwriting it.

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.