Introduced : BIG-IP_v9.4.0
Saves and encrypts the current configurations to the specified archive. This method is used to save whole configuration archive, not just what&aposs in bigip.conf or bigip_base.conf. If any “features_to_exclude” components are specified, those components are excluded from the configuration. If any “features_to_include” components are specified, those components are included from the configuration. Note that feature inclusion/exclusion will only work when the save flag is “SAVE_FULL”.


    in String filename,
    in String passphrase,
    in ConfigExcludeComponent [] features_to_exclude,
    in ConfigIncludeComponent [] features_to_include


Parameter Type Description
filename String The file name of the saved configuration archive. length limit: 255.
passphrase String The passphrase used to encrypt the saved archive.
features_to_exclude ConfigExcludeComponent [] standard features to be excluded from saved configuration
features_to_include ConfigIncludeComponent [] non-standard features to be included in the saved configuration

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.