BIG-IP F5 icon

BIG-IP F5

Interact with F5 BIG-IP via the iControl REST API

ASM → Export Policy

AI-generated

Summary

Starts an ASM export-policy task on the BIG-IP by POSTing to /mgmt/tm/asm/tasks/export-policy, which writes the chosen WAF policy to a file on the BIG-IP filesystem.

Inputs

  • Policy Reference Link (required) — Self-link of the ASM policy to export, e.g. https://localhost/mgmt/tm/asm/policies/. Sent as policyReference: {link: ...}.
  • Export Options — Optional collection. Filename sets the output file name on the BIG-IP. Format is json (default) or xml. Include Suggestions adds Policy Builder suggestions (exportSuggestions). Minimal Export exports only non-default settings (minimal).
  • Request Options — Node-level settings: batching (items per batch and interval), ignore SSL issues, proxy, and request timeout in ms (default 10000).

Output shape

The JSON response from the BIG-IP for the created export task, as a single item per input item.

The source does no post-processing. The export runs as a background task and the file is saved on the BIG-IP, not returned to the workflow. To track completion, use Check Task Status with task type 'export-policy' and the task ID from the response. The exact response fields come from the BIG-IP and are not defined in the node.

Examples

Example 1: Back up a WAF policy as JSON before making changes

Policy Reference Link = https://localhost/mgmt/tm/asm/policies/abc123; Export Options: Filename = pre_change_backup.json, Format = JSON.

Example 2: Create a compact export of only non-default settings

Policy Reference Link set to the policy self-link; Export Options: Minimal Export = true.

Example 3: Export a policy and wait for the task to finish

Run Export Policy, then Check Task Status with Task Type = Export Policy and the returned Task ID.

Links

Discussion