Introduced : BIG-IP_v9.4.0
Saves the current configurations to the specified archive. If the “save_flag” is either SAVE_HIGH_LEVEL_CONFIG or SAVE_BASE_LEVEL_CONFIG, the specified filename will be ignored, since by default, configuration will be saved into /config/bigip.conf or /config/bigip_base.conf respectively. 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 SaveMode save_flag,
    in ConfigExcludeComponent [] features_to_exclude,
    in ConfigIncludeComponent [] features_to_include


Parameter Type Description
filename String The file name of the saved configuration file. length limit: 255.
save_flag SaveMode The flag specifying the type of save to perform.
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.