Introduced : BIG-IP_v9.0
Downloads the configurations from the device.


FileTransferContext download_configuration(
    in String config_name,
    in long chunk_size,
    inout long file_offset


Parameter Type Description
config_name String The name of the configuration file to be retrieved from the device. Length limit: 255. The configuration name should not include any path information, since it will be retrieved automatically from a designated directory.
chunk_size long The chunk/block size of the file data to read from the device.
file_offset long The file offset that indicates where to read the next chunk of file data from.

Return Type

Type Description
FileTransferContext The context of the transfer operation.


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

  • 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.