Introduced : BIG-IP_v9.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.


    in String filename,
    in SaveMode save_flag


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.

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

  • PowerShell App Automation - This is a Powershell iControl Sample illustrating how to automate the process of application pools and monitors for a given Application name and version.
  • Ps Config Archiving - This PowerShell application performs archiving and restoring of your BIG-IP configuration.

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.