BIG-IP F5 icon

BIG-IP F5

Interact with F5 BIG-IP via the iControl REST API

Actions38

System → Execute CLI Command

AI-generated

Summary

Runs a TMSH command on a BIG-IP by sending a POST to the iControl REST endpoint /mgmt/tm/cli_cmd/{Command ID} with the command string in the request body.

Inputs

  • Command ID (required) — Endpoint ID appended to /mgmt/tm/cli_cmd/. Defaults to "run", which is for general commands.
  • Command (required) — TMSH command string to execute (for example show sys version). Sent as the command property of the JSON body.
  • Request Options — Optional node settings: batching (items per batch, default 50, and interval in ms, default 1000), ignore SSL issues, HTTP proxy URL, and request timeout in ms (default 10000).

Output shape

The JSON response from the BIG-IP iControl REST cli_cmd endpoint, returned as the node's output item or items.

The source doesn't transform the response, so the exact fields depend on the BIG-IP and the command run. The node authenticates with the bigIpF5Api credential, which supplies the host and the SSL setting. The default timeout is 10 seconds, so long-running commands may need a higher Timeout.

Examples

Example 1: Check the BIG-IP software version

Resource: System; Operation: Execute CLI Command; Command ID: run; Command: show sys version

Example 2: Run a command for each incoming item with throttling

Command ID: run; Command set from an expression such as {{$json.cmd}}; Request Options > Batching: 10 items per batch, 2000 ms interval

Links

Discussion