BIG-IP F5 icon

BIG-IP F5

Interact with F5 BIG-IP via the iControl REST API

Actions38

System → Create UCS Task

AI-generated

Summary

Starts a UCS (User Configuration Set) backup or restore task on a BIG-IP by POSTing to /task/sys/ucs with the chosen command and archive name.

Inputs

  • UCS Command (required) — Choose "Save (Create Backup)" (value save, the default) to create a UCS archive, or "Load (Restore Backup)" (value load) to restore one. Sent as body field "command".
  • UCS Name (required) — Name of the UCS archive, without the .ucs extension (e.g. bigip_backup). Sent as body field "name".
  • Request Options — Optional node settings: batching (items per batch, default 50, and batch interval, default 1000 ms), ignore SSL issues, an HTTP proxy URL, and a request timeout in ms (default 10000).

Output shape

The JSON response from the BIG-IP task endpoint for each input item. This is normally a task record describing the newly created UCS task.

The source defines no polling or post-processing, so the node only submits the task. The response reflects the initial task creation, not necessarily completion of the backup or restore. Authentication and base URL come from the bigIpF5Api credential. Load restores a configuration on the device, so use it with care.

Examples

Example 1: Create a nightly configuration backup

UCS Command = Save (Create Backup); UCS Name = nightly_backup, triggered from a Schedule node.

Example 2: Restore a known-good configuration

UCS Command = Load (Restore Backup); UCS Name = bigip_backup, which must be an archive already on the device.

Links

Discussion