Introduced : BIG-IP_v9.2.0
Installs the encrypted configurations contained in the specified archive to the local device. If the specified archive is not already encrypted, then the passphrase is ignored, and installation will take place as normal.


    in String filename,
    in String passphrase


Parameter Type Description
filename String The file name of the configuration file to install. length limit: 255.
passphrase String The passphrase used to decrypt the archive so we can install 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.