set_radio_tx_power
set_radio_tx_power
Section titled “set_radio_tx_power”Set the transmit power mode of one radio on an access point.
Side effects:
- Changes the AP’s RF footprint. Lowering TX power shrinks coverage; clients at the cell edge may roam to another AP or drop to a lower PHY rate. The radio applies the change within seconds (brief client re-association possible).
- Only the targeted radio changes; the device’s other radios and settings are read first and written back unchanged.
- Mutates controller state. Use dry_run=True to preview the change (including the current value) without applying.
Read first: call get_device_radios to see the current mode and
the radio’s supported dBm range before changing it.
Example
Section titled “Example”set_radio_tx_power(device_mac="aa:bb:cc:00:00:02", band="5g", mode="medium")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
device_mac | string | yes | — | AP MAC address (from list_devices). |
band | string | yes | — | "2g", "5g", or "6g" (raw UniFi ids ng, na, 6e also accepted). |
mode | string | yes | — | "auto", "high", "medium", "low", or "custom" (requires power_dbm). |
power_dbm | integer | no | 0 | Exact transmit power in dBm, only used with mode="custom". Validated against the radio’s min_txpower/max_txpower bounds. |
controller | string | no | ”default” | Name of the UniFi controller to target. Defaults to "default". |
dry_run | boolean | no | false | Preview the change without applying it. Returns the predicted change set. |