BIG-IP F5 icon

BIG-IP F5

Interact with F5 BIG-IP via the iControl REST API

Actions38

System → Download UCS File

AI-generated

Summary

Downloads an existing UCS backup archive from a BIG-IP by filename, using a declarative GET request to the iControl REST file-transfer endpoint.

Inputs

  • UCS Filename (required) — Name of the UCS file on the BIG-IP, e.g. bigip_backup.ucs. Inserted into the URL path /mgmt/shared/file-transfer/ucs-downloads/{filename}.
  • Request Options — Optional node settings: batching (items per batch, interval in ms), ignore SSL issues, HTTP proxy URL, and timeout in ms (default 10000).

Output shape

The response of the GET request to the BIG-IP, one result per input item. The node declares no custom output handling or binary-file configuration.

The request sets Accept: application/json, and no response-format override is declared, so how the UCS archive appears (JSON, text, or binary) is not defined by the node. UCS files can be large, so the default 10 s timeout may need raising. The file must already exist on the device; use Create UCS Task to make one. Host and SSL behaviour come from the bigIpF5Api credential.

Examples

Example 1: Retrieve a backup created earlier in the workflow

Resource: System, Operation: Download UCS File, UCS Filename: bigip_backup.ucs, Timeout raised to 120000 ms.

Example 2: Download from a lab device with a self-signed certificate

UCS Filename: nightly.ucs, Request Options > Ignore SSL Issues enabled.

Links

Discussion