Introduced : BIG-IP_v12.1.0
Saves the current configurations to the specified single configuration file (SCF). An SCF file is a flat file that holds an entire config, as opposed to an archive. The file can be encrypted by specifying a passphrase. Files in the system filestore in the /config/filestore directory will not be saved into the SCF file. For the files in filestore that are being referenced by the SCF configuration file, they will be automatically saved into a separate TAR file when a copy of the SCF file is saved. This TAR file can be specified. If the “save_flag” is SAVE_BASE_LEVEL_CONFIG, tarfile cannot be specified. If it is SAVE_EXCLUDE_GTM_CONFIG, neither passphrase nor tarfile can be specified. SAVE_HIGH_LEVEL_CONFIG is not supported for this feature.


    in String filename,
    in SaveMode save_flag,
    in String passphrase,
    in String tarfile


Parameter Type Description
filename String The file name of the saved single configuration file. length limit: 255.
save_flag SaveMode The flag specifying the type of save to perform.
passphrase String The passphrase used to encrypt the saved file. If this is left as an empty string, no passphrase will be used to encrypt the file.
tarfile String The tarfile that stores the files in filestore that are being referenced by the SCF configuration file. If this is left as an empty string, the tarfile will be saved with the same prefix as the filename with a .tar extension. If the tarfile is specified, the actual file will not have the .tar file extension by default, unless specified.

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.